Update API Token

Updates the name and optionally the description of a specified API Token. Include the ID of the API Token in the path and the new name and optional description in the body of the request. To retrieve the ID of the API Token call the List API Tokens API.

HTTP Request

PUT {API_URL}/api-tokens/{id}

Path parameters

Parameters	Requirements	Type	Description
id	Required	string	The unique identifier of the API Token to be deleted.

Body parameters

Parameters	Requirements	Type	Description
name	Required	string	The name of the API Token. A string with a maximum length of 50 characters.
description	Optional	string	An optional description of the API Token.

Reponse Attributes

status boolean

Indicates the success or failure of the operation. true signifies success, while false indicates an error.

message string

A message confirming the status of the request to update the specified API Token.

data object

Returns the data object, containing details of the updated API Token.

Each API Token specifies the following properties:

• name: The name of the API Token.
• token: The API Token value used to authenticate API requests.
• description: An optional description of the API Token.
• created_at: The timestamp when the API Token was created.
• id: The API Token ID.

Example

Request

curl -X PUT '{API_URL}/api-tokens/{id}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json' \
-d '{
    "name":"exabits-test-token-new",
    "description":"This is an example API Token"
}'

Response

{
    "status": true,
    "message": "Updating API Token successful",
    "data": {
        "name": "exabits-test-token-new",
        "id": "670881c41221aabc72ed946b",
        "description": "This is an example API Token",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVC...",
        "created_at": 1728610756
    }
}