API Keys

Org-scoped API keys (used by user-facing webhooks, docker registry login, etc.)

List API keys

GET

/api/v1

/org/api-keys

auth_token (cookie)

Returns metadata for the org's user-created API keys. The plaintext value is never included.

List API keys › Responses

List of API keys (plaintext value never included)

object[]

Create an API key

POST

/api/v1

/org/api-keys

auth_token (cookie)

Provision a new api_key for the caller's org. The plaintext value is returned exactly once (api_key) and must never be exposed by list endpoints. Managing API keys is JWT-only: an API token cannot mint or revoke credentials, so this endpoint does not accept bearerAuth.

Create an API key › Request Body

name

string · required

scope

string · required

Scope token (e.g. all, deploy, docker). Multi-scope keys use ; as separator. Use all for general API access.

permission

string · enum

Access level of the key. Defaults to read. Mutating API calls and docker push require write.

Enum values:

read

write

Default: read

Create an API key › Responses

API key created (plaintext value included once)

id

string · uuid · required

scope

string · required

source

string · required

Always user for keys created via this endpoint.

permission

string · enum · required

Enum values:

read

write

created_at

string · date-time · required

api_key

string · required

Plaintext key value — returned only here, never again.

name

string

Delete an API key

DELETE

/api/v1

/org/api-keys/{id}

auth_token (cookie)

Delete an API key › path Parameters

id

string · uuid · required

Delete an API key › Responses

API key deleted

No data returned

Proxy Registries