Skip to main content
POST
Create API Key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-partner-id
string
default:""
required

The Partner ID header used for authorization

idempotency-key
string
default:""
required

The Idempotency Key - usually a UUID

Body

application/json

Request to create a new API key

name
string
required

Name of the API key

Example:

"Developer Api Key"

access
object
required

Access rights configuration

description
string

Description of the API key

Example:

"Api key for developers"

enabled
boolean

Whether the API key is enabled

Example:

true

Response

Response containing API key information

Standard response structure for successful operations

ok
boolean

Indicates if the operation was successful

Example:

true

data
object

API key information