Skip to main content
POST
Create API Key

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
name
string
required

Name for the API key

Example:

"read-only-key"

permissions
object

JSON object containing permission definitions

Example:
key_params
object

Optional wildcard parameters for advanced keys

Example:

Response

Returns {success: true, id, key, permissions} with the plaintext key (shown once only).

success
boolean

Whether the key was created

id
integer

ID of the new API key

key
string

Unhashed API key value — shown only once

permissions
object

Permissions assigned to the new key