Get API Key

Beta
GET/v1/auth/api-keys/{id}

This endpoint is idempotent. Learn more

Returns API key metadata by ID.

idstring

API key ID.

include[]optional arrayenumValues:rolerole.permissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

API key ID.

objectstringenumValues:api_key

Resource type identifier.

namestring

Human-readable name for the API key.

redacted_valuestring

Redacted key value.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.
permissionsarray of stringExpandablenullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

Last used timestamp.

expires_atstring (date-time)nullable

Expiration timestamp.

revoked_atstring (date-time)nullable

Revocation timestamp.

Responses

200

Successful response for Get API Key