Create an application token
Creates an application token for the requesting organisation and returns it.
The token itself is only available from this response and cannot be retrieved later, so store it immediately. The number of active tokens an organisation may hold is limited.
Authentication
AuthorizationBearer
An auth_token should be provided to authenticate a session.
To obtain an auth_token, see the /api/v1/authenticate POST request.
Request
This endpoint expects an object.
name
Name of the application token. Letters, digits, spaces and - _ . : / ( ) [ ] @ + # are allowed.
roles
The role granted to the token.
Exactly one role is assigned, and the Support role can't be assigned to a token.
expiry_date
Expiry date in ISO 8601 format, either 2027-08-21T10:00:00.000Z or 2027-08-21 10:00:00.
A value carrying no time zone is read as UTC.
Must be at least one day in the future and at most 10 years in the future.
ip_restrictions
IP addresses the token may connect from. Each entry is an IPv4 address, optionally in CIDR notation. Omit to allow any address.
Response
Application token created
id
Unique ID of this application token.
name
status
roles
The role granted to the token.
created_date
ip_restrictions
IP addresses the token may connect from. Absent where it may connect from any.
expiry_date
Absent for a token created without one through the v1 API.
last_used_date
Absent until the token has been used.
last_used_ip
IP address the token was last used from.
created_by
A user that acted on the token. Absent where an application token acted instead.
last_modified_date
Absent until the token has been modified.
last_modified_by
A user that acted on the token. Absent where an application token acted instead.
deleted_date
Set only once the token has been deleted.
deleted_by
A user that acted on the token. Absent where an application token acted instead.
token
The application token. Store it immediately after creation, it is not retrievable afterwards.
Errors
400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error