Skip to main content
POST
Issue API key

Authorizations

Authorization
string
header
required

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

Body

application/json
key_name
string
required

API key name

email
string<email>

Issue the key for another user of the account (root and administrators only). Defaults to the caller.

scope
enum<string>
default:user

user keys act as the issuing user. account keys are shared by the account and can be issued only by root and administrators.

Available options:
user,
account
expiry_days
integer

Days until the key expires. Defaults to 90. A negative value means the key does not expire.

allow_endpoints
object[]

Restrict the key to these endpoints

allow_sub_subjects
string[]
deny_sub_subjects
string[]
allow_pub_subjects
string[]
deny_pub_subjects
string[]
resp_permission
object

Response permission for request/reply

Response

API key created successfully

data
object
required

Returned once, on creation. The full key cannot be read again.