API Keys

Create an API Key

Changed on

Generates a new programmatic API key for accessing authorized resources. The full, secret API key is returned ONLY once in this response and cannot be recovered later.

post/v1/api-keys

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/v1/api-keys
  • Auth: HTTP bearer

Request body

namestring required

Descriptive name for the key.

org_idstring uuid required

Organization that owns the API key.

team_idsstring[]

Optional list of teams the key can access. Omit or pass an empty array for organization-wide access.

operation'read_render' | 'all' | 'admin'

Example request

{
  "name": "ci-pipeline"
}

Response

API key created successfully

idstring uuid required

Unique API Key identifier.

namestring required

Human-readable name of the key.

keystring required

The fully generated secure raw API Key string. This is returned ONLY ONCE.

operationstring required
created_atstring date-time required

Timestamp of creation.

Example response

{
  "key": "ak_7f9ba3271cf881309d9be8c9c0fcae47a95b8d29c3f0b2da8e89cf21e5c3df01"
}

Changes