Skip to main content
GET
Get API key usage

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

apiKeyId
string
required

API key ID returned by GET /api-keys.

Response

Usage and created resources for the key.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

id
string
required
Example:

"sak_123"

name
string
required
Example:

"Production worker"

keyPrefix
string
required
Example:

"box_live"

keyLastFour
string
required
Example:

"9abc"

sandboxId
string | null
required

Box ID for a platform-managed machine key, or null for a user-created key.

createdAt
string<date-time>
required
lastUsedAt
string<date-time> | null
required
usage
object
required
resources
object
required
createdResources
object[]
required