Skip to navigation
Application TokensUpdate an application token

Update an application token

Changes the name and/or the role of an application token.

Omitted fields keep their current value. Expiry date and IP restrictions are fixed for the life of a token.

To revoke a token, use DELETE /api/v2/application_token/{id}. A status field in the request body is ignored.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

idintegerRequired>=1
The id of the application token.

Request

This endpoint expects an object.
namestringOptional2-64 characters

Name of the application token. Letters, digits, spaces and - _ . : / ( ) [ ] @ + # are allowed.

roleslist of objectsOptional
The role granted to the token. Exactly one role is assigned, and the Support role can't be assigned to a token.

Response

Application token updated
idinteger
Unique ID of this application token.
namestring
statusobject
roleslist of objects
The role granted to the token.
created_datestringformat: "date-time"
ip_restrictionslist of objectsOptional
IP addresses the token may connect from. Absent where it may connect from any.
expiry_datestringOptionalformat: "date-time"
Absent for a token created without one through the v1 API.
last_used_datestringOptionalformat: "date-time"
Absent until the token has been used.
last_used_ipstringOptional
IP address the token was last used from.
created_byobjectOptional
A user that acted on the token. Absent where an application token acted instead.
last_modified_datestringOptionalformat: "date-time"
Absent until the token has been modified.
last_modified_byobjectOptional
A user that acted on the token. Absent where an application token acted instead.
deleted_datestringOptionalformat: "date-time"
Set only once the token has been deleted.
deleted_byobjectOptional
A user that acted on the token. Absent where an application token acted instead.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error