AXaxiom
tokens

POST /tokens

Changed on

Creates an API token and returns its secret token value, which you can't retrieve again. You can only grant capabilities you have yourself. If you omit expiresAt, the token doesn't expire.

Request

  • Base URL
    https://api.axiom.co/v2
  • Auth
    OAuth 2
    Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
    Token URLhttps://www.googleapis.com/oauth2/v4/token
    ScopesapiTokens|create
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

datasetCapabilitiesDatasetCapabilities
descriptionstring

Description of the token

expiresAtstring date-time nullable

Expiration date of the token (ISO 8601 format)

namestring required

Name of the token

viewCapabilitiesViewCapabilities

Response

Created API token, including its secret token value.

apiLastUsedstring date-time nullable

When the token was last used on an API other than ingest

auditIdentitystring

Audit identity of the token

datasetCapabilitiesDatasetCapabilities required
descriptionstring

Description of the token

expiresAtstring date-time nullable

Expiration date of the token (ISO 8601 format)

idstring required

ID of the token

ingestLastUsedstring date-time nullable

When the token was last used to ingest

namestring required

Name of the token

samlAuthenticatedboolean
viewCapabilitiesViewCapabilities
tokenstring

Changes

  • v2fbc1b8430febRevision changes
    • info

      added the non-success response with the status

  • v28920e1697284Revision changes
    • warning

      removed the request property //

    • warning

      removed the request property /

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      added the new optional request property /

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status