Skip to main content
POST
Create API Key
Store the returned api_key securely - it will not be shown again.

Body

application/json

Request model for creating an API key.

name
string
required

Human-readable name for the API key.

Required string length: 1 - 256
scopes
ApiKeyScope · object[]
required

List of resource scopes. At least one scope is required.

Minimum array length: 1
sharing_group_ids
string[]
required

IDs of groups that receive default admin grants on key-created resources.

Minimum array length: 1
description
string | null

Optional description.

Maximum string length: 1000

Response

Successful Response

Response model for API key creation.

Includes the full API key (shown only once).

api_key
ApiKeyResponse · object
required

The created API key metadata.

key
string
required

The full API key. Store securely - it will NOT be shown again.