Skip to main content

Retrieve an API key.

Retrieve an API key.

Path Parameters
api_key_name string REQUIRED

Unique API key name

Responses
200

API key retrieved successfully

Schema OPTIONAL
id uuid

API key identifier.

name string
scopes string[]

Possible values: [Read, Write]

404

API key with that name does not exist

Schema OPTIONAL
details object

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.