Skip to main content
GET
List API keys

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

projectId
string<uuid>

ID of the project (with an API key, the key's own project). Required with scope=all. Without it, scope=own lists your keys in every project and leaves out effectiveScopes and hasStaleScopes.

Example:

"fbb9e8b2-2dbb-40f9-a051-9404624e3247"

scope
enum<string>
default:own

own: your keys. all: every member's keys (OWNER and ADMIN only).

Available options:
own,
all
Example:

"own"

kind
enum<string>

Only keys of this kind.

Available options:
LEGACY,
PUBLIC,
SECRET
Example:

"SECRET"

Only keys whose name contains this.

Minimum string length: 1
Example:

"server"

status
enum<string>

scope=all only: keys with this status.

Available options:
ACTIVE,
DISABLED,
REVOKED
Example:

"ACTIVE"

ownerId
string<uuid>

scope=all only: keys of this member.

Example:

"b7d9e979-4a16-437b-8571-4ed92a94faa8"

skip
integer
default:1

Page number, starting at 1.

Required range: x >= 1
Example:

1

take
integer
default:10

Keys per page.

Required range: x >= 1
Example:

10

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"success"

data
Your keys (scope=own) · object