Skip to navigation
REST APIAuthentication and AuthorizationAccess Keys

Create an access key.

View as Markdown
Used to create an access key.

Authentication

AuthorizationBearer
Bearer authentication

Request

Access key object to create
namestringRequiredformat: "^[a-z][-_a-z0-9]*[a-z0-9]$"2-255 characters
The name of the access key. The name must be unique within the user's access keys list and can only contain lowercase alphanumeric characters and hyphens. It must start and end with a letter.

Response

Executed successfully.
idstring
The unique identifier of the access key.
clientIdstring
The client identifier associated with the access key. Used when requesting authentication tokens.
namestring
The name of the access key.
clientSecretstring
Secret credential paired with the client ID. Used to obtain authentication tokens. Displayed only once upon creation.
createdAtdatetime or null
The timestamp for when the access key was created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error