API key

OAuth client credentials that act for your user, for the SDK, CLI and Terraform.

On this page: REST

REST#

Create an API key#

POST /api/user-keys

Body (application/json):

Field	Type	Default	Description
`name`	`string`	none	A name for the key.
`scope`	`string[]`	none	Namespaces the key is limited to.

Returns: 201 with:

Field	Type	Default	Description
`client_id`	`string`	none	OAuth client ID.
`client_secret`	`string`	none	OAuth client secret. Returned once; it cannot be read again.
`name`	`string`	none	The key's name.
`scope`	`string[]`	none	Namespaces the key is limited to.
`token_url`	`string`	none	Token endpoint for the client-credentials grant.

Errors: 400, 401 (Errors).

List API keys#

GET /api/user-keys

Returns: 200 with an object with keys (object[]), keys[].client_id (string), keys[].id (string), keys[].name (string), keys[].scope (string[]).

Errors: 401 (Errors).

Revoke an API key#

DELETE /api/user-keys/{id}

Parameter	In	Description
`id`	path	The object id.

Returns: 204. No Content.

Errors: 401, 403 (Errors).