Skip to main content
POST
Error

Authorizations

​
X-API-Key
string
header
required

Body

application/json

API key POST schema.

expires_at: Optional datetime when the API key will expire. workspaces: List of workspace UUIDs this key can access (feature-flagged). role_id: Optional UUID of the role to assign to API key. If not provided, uses default role based on read_only flag: - WORKSPACE_ADMIN if read_only is False - WORKSPACE_READER if read_only is True org_role_id: UUID of an org role for service keys. Workspace-scoped keys accept only the built-in ORGANIZATION_VIEWER or ORGANIZATION_RESTRICTED role. Defaults to ORGANIZATION_VIEWER for workspace-scoped keys, or ORGANIZATION_USER for org-scoped keys. default_workspace_id: UUID of the default workspace for PATs. If not provided, uses the current logic (first available workspace).

​
description
string
default:Default API key
​
read_only
boolean
default:false
deprecated
​
expires_at
string<date-time> | null
​
workspaces
string<uuid>[] | null
​
role_id
string<uuid> | null
​
org_role_id
string<uuid> | null
​
default_workspace_id
string<uuid> | null

Response

Successful Response

API key POST schema.

​
id
string<uuid>
required
​
short_key
string
required
​
description
string
required
​
key
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.