Skip to main content
POST
Create a key

Authorizations

Api-Key
string
header
required

Body

application/json

The key to create

name
string
required

The name of the key

expiresAt
string
required

The time the key expires

role
enum<string>

The role of the key - if not provided, it will default to admin

Available options:
admin,
readonly,
custom,
webhookSigning
permissions
string[]

The permissions of the key - required if role is custom, will ignore if provided and role is admin, readonly, or webhookSigning. Must contain at least one permission.

Items must be in the format resource:action and correspond to the available resources and actions in the Authenticating with the API reference

Example:
ipAddresses
string[]

Optional list of IP addresses or CIDR ranges that are allowed to use this API key. If not provided or empty, requests from any IP address are allowed. Supports both IPv4 and IPv6. Maximum 100 entries.

Maximum array length: 100

An IPv4 address (e.g., 192.168.1.1), IPv6 address, or CIDR range (e.g., 10.0.0.0/24)

Example:

Response

Successful operation

id
string<uuid>
required

The key's unique identifier

key
string
required

The key

name
string
required

The key's name

expiresAt
string<date-time>
required

The time at which the key expires

role
enum<string>

The key's role

Available options:
admin,
readonly,
custom,
webhookSigning
permissions
string[]

The key's permissions

ipAddresses
string[]

The IP addresses or CIDR ranges allowed to use this key. If empty, any IP is allowed. Maximum 100 entries.

Maximum array length: 100