Skip to Content
API ReferencePlatformGet API Key

Get API Key

GET/v0/api_keys/{api_key_name}
Authentication
Parameters

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

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

NameTypeRequiredDescription
api_key_namestringYesUnique API key name

Response

application/json
API key retrieved successfully
  • object
    API key descriptor.
    • idstring (uuid)required
      API key identifier.
    • namestringrequired
    • scopesApiPermission[]required
Request
curl -X GET '/v0/api_keys/{api_key_name}' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
API key with that name does not exist
{ "message": "Unknown API key 'non-existent-api-key'", "error_code": "UnknownApiKey", "details": { "name": "non-existent-api-key" } }