Platform

Get API Key

Required role: write or higher.

Retrieve the metadata of a specific API key by its name.

get/v0/api_keys/{api_key_name}

Request

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

Path parameters

api_key_namestring required

Unique API key name

Response

API key retrieved successfully

idstring uuid required

API key identifier.

namestring required
role'read' | 'write' required

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.

Changes

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