How to obtain your Axiom API token
Overview
To authenticate with Axiom, you will need:
- Edge / region (subdomain) β For ingest and query, use your edge deployment; for all other endpoints you can use the default
(api). - API token β A key that grants Tenklo permission to interact with Axiom's API resources and services.
This guide covers configuring the base domain and creating an API token (basic or advanced).
Prerequisites
- An Axiom account
Step 1: Finding your subdomain
The base domain of an API request depends on the operation:
- Ingest and query β Use the base domain of your edge deployment (see table below).
- All other API endpoints β Use
api.
In Tenklo, enter the subdomain that corresponds to your edge (the part before .axiom.co):
| Edge deployment | Subdomain (enter in Tenklo) |
|---|---|
| US East 1 (AWS) | us-east-1.aws.edge |
| EU Central 1 (AWS) | eu-central-1.aws.edge |
Step 2: Generating your API token
- In Axiom, go to Settings β API tokens, then click New API token.
- Name your API token.
- Optional: Add a description and set an expiration date.
- Under Token permissions:
- Basic β for ingesting data; select which datasets the token can access.
- Advanced β for querying, managing datasets, and other actions; select datasets and actions.
- Click Create.
- Copy the API token and store it securely. It wonβt be shown again.
Generate API tokens when needed instead of Personal access tokens (PAT), as PATs provide full control over your Axiom account.
Step 3: Enter credentials in the Connect UI
Once you have your API token:
- Open the form where you need to authenticate with Axiom
- Enter your API token in their respective fields
- Submit the form, and you should be successfully authenticated
You are now connected to Axiom.