Skip to main content
GET
Core - Retrieve key metadata
Related guide: API keys guide. See the API keys guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

api_key_id
string
required

Unique identifier of the API key.

Response

The API key

id
string
required

Unique identifier of the key.

name
string
required

Display name of the key.

token
string
required

The raw secret on create only; a masked display value everywhere else.

workspace_id
string
required

Workspace the key belongs to.

access
object
active
boolean
constraints
object
created
string<date-time>
created_by_id
string
expiration
string
is_legacy
boolean
last_used_at
string<date-time>
legacy_key_id
string
legacy_token_family
string
owner
object
permission_mode
enum<string>
Available options:
all,
restricted,
read_only
project_scope
object
projects
string[] | null
source
string
status
enum<string>
Available options:
active,
disabled,
revoked
token_prefix
string

Display prefix of the secret; not usable as a credential.

updated
string<date-time>
updated_by_id
string