Get all API keys.

GET

/api-keys

Get all API keys.

Authorizations

• publicOauth2
  read:api-key

Responses

200

A collection of API keys

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

object

count

required

Number of items returned in the result.

integer

Example:

1

apiKeys

required

Array<object>

An API key

object

name

required

string

clientId

required

string

Example

Content type: application/json

Copied!

{ 

{

"count": 1,

"apiKeys": [ 

{ 

"name": "string",

"clientId": "string"

}

]

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

500

Internal Server Error

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

501

The endpoint has not been implemented yet.

Response Schema

object

message

string

Example:

This endpoint has not been implemented yet.

Example

Content type: application/json

Copied!

{ 

{

"message": "This endpoint has not been implemented yet."

}