Regenerate API token
Creates a new API token with the existing token's capabilities, or with those in newToken, and returns its secret value. The existing token keeps working until existingTokenExpiresAt; set it to the current time to revoke it immediately.
Parameters
| Property | Type | Location | Description |
|---|---|---|---|
id | stringRequired | path |
Body
application/json| Property | Type | Description |
|---|---|---|
existing | stringRequired | Expiration date of the existing token (ISO 8601 format) |
new | object | |
dataset | object | |
description | string | Description of the token |
expires | string | Expiration date of the token (ISO 8601 format) |
name | stringRequired | Name of the token |
org | object | |
annotations | string[] | Annotations capability |
api | string[] | API tokens capability |
audit | string[] | Audit Log capability |
billing | string[] | Billing capability |
dashboards | string[] | Dashboards capability |
datasets | string[] | Datasets capability |
endpoints | string[] | Endpoints capability |
integrations | string[] | Integrations capability |
labels | string[] | Labels capability |
monitors | string[] | Monitors capability |
notifiers | string[] | Notifiers capability |
rbac | string[] | Access control capability |
shared | string[] | Shared access keys capability |
users | string[] | Users capability |
views | string[] | Views capability |
view | object | |
new | string | Expiration date of the new token (ISO 8601 format) |
Request
Try itRun this request against your Axiom organization
Credentials stay in this browser tab and are only sent to Axiom when you run the request.
Response
200New API token, including its secret `token` value.400Missing `existingTokenExpiresAt`, expiry set in both `newTokenExpiresAt` and `newToken.expiresAt`, or invalid capabilities in `newToken`.
404API token not found or expired.