Sign in
Platform

Create API Key

Required role: write or higher.

Create a new API key with the specified name. The generated API key will be returned in the response and cannot be retrieved again later.

post/v0/api_keys

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

namestring required

Key name.

role'read' | 'write'

The role an API key carries: read or write. API keys cannot be granted admin or owner; those roles are held only by interactive logins and OIDC trust relationships.

Example request

{
  "name": "my-api-key"
}

Response

API key created successfully

api_keystring required

Generated secret API key. There is no way to retrieve this key again through the API, so store it securely.

idstring uuid required

API key identifier.

namestring required

API key name provided by the user.

Example response

{
  "api_key": "apikey:v5y5QNtlPNVMwkmNjKwFU8bbIu5lMge3yHbyddxAOdXlEo84SEoNn32DUhQaf1KLeI9aOOfnJjhQ1pYzMrU4wQXON6pm6BS7Zgzj46U2b8pwz1280vYBEtx41hiDBRP",
  "name": "my-api-key"
}

Changes

No recorded changes to this operation across all 51 revisions of this API.