API Keys

Update an API Key

Changed on

Update the name, operation, or scoped teams of an existing API key.

put/v1/api-keys/{id}

Request

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

Path parameters

idstring uuid required

The unique UUID of the API Key to update.

Request body

namestring

Descriptive name for the 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'

Response

API key updated successfully

Changes