Skip to main content
PATCH
Error

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
api_key_id
string<uuid>
required

Body

application/json

API key PATCH schema.

role_id: New workspace-level role to apply to every workspace identity attached to the key. Optional; omit to leave workspace roles unchanged. org_role_id: New org-level role to apply to the key's org identity. Workspace-scoped keys accept only the built-in ORGANIZATION_VIEWER or ORGANIZATION_RESTRICTED role. Optional; omit to leave the organization role unchanged.

​
role_id
string<uuid> | null
​
org_role_id
string<uuid> | null

Response

Successful Response

API key GET schema.

role_id, org_role_id, and access_scope let clients render the key's current role state without a second round trip. For workspace-scoped service keys, org_role_id comes from the parent organization identity.

​
id
string<uuid>
required
​
short_key
string
required
​
description
string
required
​
created_at
string<date-time> | null
​
read_only
boolean
default:false
deprecated
​
last_used_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
revoked_at
string<date-time> | null
​
workspace_names
string[] | null
​
default_workspace_name
string | null
​
role_id
string<uuid> | null
​
org_role_id
string<uuid> | null
​
access_scope
enum<string> | null
Available options:
organization,
workspace
​
created_by
string | null
​
is_tracing_key
boolean
default:false
​
workspace_ids
string<uuid>[]
​
can_delete
boolean
default:false

Whether tracing-key deletion authority has been confirmed. Legacy key responses do not evaluate this capability.