Skip to main content

Get API Key

Required role: write or higher.

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

Path Parameters
api_key_name string REQUIRED

Unique API key name

Responses
200

API key retrieved successfully

Schema OPTIONAL
object[]
id uuid

API key identifier.

name string
role string

Possible values: [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.

404

API key with that name does not exist

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.