Skip to navigation

List Keys

Return the organization’s API keys, newest first, with their current usage. The management key’s organization is implied by the key itself. A page holds at most 100 keys; while has_more is true, advance offset to read the rest. Filter with project_id or disabled.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Query parameters

offsetintegerOptional>=0Defaults to 0
Number of keys to skip.
limitintegerOptional1-100Defaults to 100

Maximum number of keys to return (at most 100).

project_idstring or nullOptionalformat: "uuid"
Only keys scoped to this project.
disabledboolean or nullOptional

Only disabled keys (true) or only enabled keys (false).

Response

The list of API keys
datalist of objects
The keys on this page, newest first.
has_morebooleanOptionalDefaults to false

True when more keys remain beyond this page. Advance offset until it’s false.

object"list"OptionalDefaults to list

Always list.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
503
Service Unavailable Error