Skip to main content
POST
List And Create API Keys

Authorizations

Authorization
string
header
required

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

Body

application/json

expires_at must be in the future and is immutable once the key exists. Omitted, the new key inherits the authenticating key's expiry, and never expires only when that key never does. A key cannot create one that outlives it: an expires_at later than the authenticating key's own returns 403.

name
string

Name of api key.

permissions
ApiKeyPermissions · object

Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.

expires_at
string<date-time>

Time at which api key expires. Omitted when it does not expire.

Response

Response with status 200

The secret-bearing bearer key, or the registered public key without any secret.

api_key_id
string
required

ID of api key.

api_key
string
required

API key.

prefix
string
required

Prefix of api key.

name
string
required

Name of api key.

created_at
string<date-time>
required

Time at which api key was created.

pod_id
string

Pod ID the api key is scoped to. If set, the key can only access resources within this pod.

inbox_id
string

Inbox ID the api key is scoped to. If set, the key can only access resources within this inbox.

permissions
ApiKeyPermissions · object

Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.

expires_at
string<date-time>

Time at which api key expires. Omitted when it does not expire.