ALTER API_TOKEN

Syntax

ALTER API_TOKEN api_token_name RENEW TOKEN;

Description

Modify an existing API_TOKEN for a User in the current Organization.

Arguments

api_token_name

This specifies the name of the API_TOKEN to modify.

Examples

Refresh an existing API_TOKEN

This example shows an existing API token my_token getting renewed:

<no-db>/<no-store># LIST API_TOKENS;
+----------+-------------------------------+-------------------------------+-------------------------------+
|  Name    |  Last Used                    |  Created At                   |  Expires At                   |
+==========+===============================+===============================+===============================+
| my_token | 2024-07-11 20:38:32 +0000 UTC | 2024-07-11 20:37:17 +0000 UTC | 2024-10-09 20:37:17 +0000 UTC |
+----------+-------------------------------+-------------------------------+-------------------------------+
<no-db>/<no-store># ALTER API_TOKEN my_token RENEW TOKEN;
+-----------+----------+----------+------------------------------------------+--------------------------------+
|  Type     |  Name    |  Command |  Summary                                 |  Token                         |
+===========+==========+==========+==========================================+================================+
| api_token | my_token | ALTER    | api_token my_token was successfully      | <redacted_refreshed_api_token> |
|           |          |          | refreshed                                |                                |
+-----------+----------+----------+------------------------------------------+--------------------------------+

Notice how the creation and expiration time of the API token changes and last used time resets after the ALTER statement successfully executes:

<no-db>/<no-store># LIST API_TOKENS;
+----------+------------+-------------------------------+-------------------------------+
|  Name    |  Last Used |  Created At                   |  Expires At                   |
+==========+============+===============================+===============================+
| my_token | <null>     | 2024-07-11 20:38:50 +0000 UTC | 2024-10-09 20:38:50 +0000 UTC |
+----------+------------+-------------------------------+-------------------------------+