Skip to main content

API Keys

API key management

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List API keys

GET/api/v1/api-keys

Responses

200 List of API keys

GET/api/v1/api-keys

List API keys

https://api-test.orderly-hub.com/api/v1/api-keys

Create API key (admin only)

POST/api/v1/api-keys

Request body

FieldTypeDescription
namestring
scopesarray
expiresAtstring
{
"name": "Jane Doe",
"scopes": [
"string"
],
"expiresAt": "2026-07-23T12:00:00Z"
}

Responses

201 API key created (includes the key value, shown only once)

POST/api/v1/api-keys

Create API key (admin only)

https://api-test.orderly-hub.com/api/v1/api-keys

Delete API key (admin only)

DELETE/api/v1/api-keys/{id}

Parameters

NameInRequiredTypeDescription
idpathyesstring

Responses

200 API key deleted

DELETE/api/v1/api-keys/{id}

Delete API key (admin only)

https://api-test.orderly-hub.com/api/v1/api-keys/