Documentation menu
API Keys

Create an API key

POST /api/v1/api-keys

Requires api-keys:create. Sessions must specify organizationId. Organization-scoped credentials may omit it. API-key callers can delegate only a subset of their own grants. Rotate by creating a replacement and revoking the old key.

Parameters

query

NameTypeRequiredDescription
organizationIdstringoptionalSelects the organization that owns the collection. Required for session credentials. A credential scoped to one organization may omit it. Applies to Create an API key.

Request body

Required — Request body for: Create an API key.

application/json

NameTypeRequiredDescription
namestringoptional
grantsone of 4 typesrequired
expiresInintegeroptional
expiresAtstring | nulloptional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)