API Keys

get

List API Keys

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Query parameters
withRevokedbooleanOptional

Include revoked API keys in the response.

withExpiredbooleanOptional

Include expired API keys in the response.

Responses
chevron-right
200Success

No content

get
/api/rbac/apikeys/list

No content

post

Create API Key

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Body
descriptionstringOptional

Optional description for the API key.

expirationDatestring · date-timeOptional

Optional expiration date for the API key. Format: date-time

namestringRequired

User-defined name for the API key.

serviceAccountIdstringRequired

The UUID of the service account this key belongs to.

Responses
chevron-right
200

CreateApiKeyResponseWrapper defines the response structure for creating an API key.

No content

post
/api/rbac/apikey/create

No content

delete

Delete API Key

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

ID of the API key to delete (revoke)

Responses
delete
/api/rbac/apikey/{id}

No content

Last updated