Sign in
workspace

Create a workspace API key

[cloud-only] Creates a new API key for the current workspace.

post/api/workspace/api-keys

Request body

namestring required

Display name for the API key

descriptionstring

User-provided description of the key's purpose

Response

API key created

idstring uuid required

API key ID

namestring required

User-provided label

descriptionstring required

User-provided description of the key's purpose. Limit is byte-based (UTF-8 encoding); 5000 bytes equals 5000 ASCII characters or fewer multi-byte characters.

keystring required

The full plaintext API key (only shown once)

key_prefixstring required

First 8 chars after prefix for display

expires_atstring date-time

When the key expires (if set)

created_atstring date-time required

When the key was created

Changes