This section walks you through the most essential Axiom settings.
Obtain a token in the Axiom UI
You can generate an API token and Personal token manually in your Axiom user settings.
The API token is to used to send, and query data to one or more datasets. API tokens do not allow control of your organization, they are only used to ingest and query events, while the Personal token is used to access the Axiom API programmatically for custom integrations or for tools such as the Axiom CLI.
To generate an API Token
- Under settings, select API Tokens
- Select Add API Token
- Enter a Name and Description
- Select what permissions you want to grant your API Token.
- You can choose Ingest, Query, or Ingest and Query
- Select your dataset access. You can Allow access to any dataset or You can allow access to specific datasets only
- Copy the generated token to your clipboard. Once you navigate from the page, token can be seen again by selecting API Tokens.
API token is to used to send, and query data to one or more datasets. API tokens do not control of your organization.
For security reasons it is advised to use an API Token with minimal privileges only.
To generate a Personal Token
- Under settings, select profile
- Select Add personal Token
- Enter a Name and Description and select ADD
- Copy the generated token to your clipboard. Once you navigate from the page, token can be seen again by selecting Personal token
- Personal token grants access to all resources available to the user also use the personal token to access Axiom API programmatically for custom integrations or for tools such as the Axiom CLI.
- You need the
AXIOM_ORG_IDwhen using a personal token for Axiom Cloud.
The best way to get started with our API is to use Go-Axiom to send events directly to Axiom.
Manage your project billing, view your current plan, and explore the total usage of each component during your current billing period up to the last hour.
You can upgrade your organization to a free 14-day trial. Axiom will not charge you during the first 14 days of your Axiom Pro trial. You can cancel at any time during the trial period without incurring any cost.
At the end of the trial period, your account will automatically convert to a paid plan.
On the Billings dashboard you can get the total usage of each running component during the current billing period up to the last hour and beyond.
Manage datasets for your organization, including creating new datasets or deleting existing datasets.
Datasets are a collection of similar events. When data is sent to Axiom it is stored in a dataset.
Dataset names must be between 1-128 characters, and may only contain ASCII alphanumeric characters and the '-' character.
To create a dataset, enter the name and description of your dataset.
Endpoints allow you to easily integrate Axiom into your existing data flow using tools and libraries that you already know. With Endpoints, you can build and configure your existing tooling to send data to Axiom so you can start monitoring your logs immediately.
Learn more about configuring endpoints
Gain complete visibility into any platform, and get alerts on your errors to stay ahead of issues.
By properly monitoring your integrations with Axiom, you can spot slowdowns, hiccups, bad requests, errored requests, and function cache performance and know which actions to take to correct these issues before there are user-facing consequences.
Check out supported integrations
You can see the license and instance configuration for your organization by selecting Status this lets you know:
- How much data you can ingest.
- How long can you use your Instance.
- Maximum Datasets you can have.
- Maximum number of Users.
- Maximum number of Teams.
- Maximum Query Window.
Teams enable members of an organization to work together on projects, making it easy to collaborate and manage your Axiom projects.
If you’re a team Owner or Admin, you can add new team members to the team by clicking on New team at the upper right corner on the Axiom UI.
Enter the name of the user you want to add as a member.
Search for the team member you want to add to your Team.
Only users with the roles User or Read Only can be added as team members. Once a user is added to one or more teams, they can only see the datasets that are visible to those teams.
- Teams conditions don't apply to Admins and Owners as they don't have the User or Read Only roles.
After signing up, you can control access to your Axiom account by managing the user list. In the Axiom UI, click on Settings, and select Users.
Roles are grouped into Owner, Admin, User, and Read Only User. Members in your organization can be attached the Admin, User and Read Only User roles.
- Owners have the highest level of authority and control over the Axiom platform. With the owner role, you can manage all user permissions, add or remove admins, manage organization settings, and delegate user and admin responsibilities. Team owners can add a user's name, email, and also assign a specific role.
- Admins are users with elevated privileges in the Axiom platform, assigned by the owner to manage and maintain various organization settings. Admins also manage user access, roles, and permissions, ensuring that team members have the appropriate access levels and resources to perform their tasks.
- Users with the user role permission have a broader set of permissions that allow them to interact with the Axiom platform and dataset visible to their teams. They can collaborate with other team members and create, edit, and manage configurations depending on their assigned permissions.
- Users with a read-only user role have limited permissions, allowing them to view and access Axiom resources without modifying them. Read-only users cannot edit, create, or delete configurations attached to an organization.
View your contact details, edit your timezone, and create your personal token from your organization profile.