Skip to main content
Everything you can do in the dashboard, you can do through the API. It is the same API the dashboard uses, so there is no second-class surface and nothing that only the interface can reach.
This reference is generated from the running route table, so it cannot drift from what the API actually accepts. The endpoint pages beneath this one carry parameters, request shapes and status codes per operation.

​
Authenticate

Two credentials, and using the wrong one is the most common first error.
A license key does not work on the API. It authenticates ingest only. A request to /api/logs carrying X-License-Key is unauthenticated and returns 401.The reverse is also true — a session token will not ingest telemetry. See Authentication.
Browser clients use an HttpOnly cookie set at sign-in; programmatic clients use a bearer token. Both resolve to the same session.

​
Your organization is not a parameter

Many endpoints accept a tenantId query parameter. It is a historical artefact and it is always overwritten from your session.
Naming an organization other than your own returns 403, not your own data. The failure is visible rather than silently corrected — so a bug in your client surfaces immediately instead of producing plausible results from the wrong place.You never need to send it. A value that must equal your session’s is a value with no reason to exist.

​
Errors

Every non-2xx response uses one shape:
Branch on error, never on message. The error code is stable and is part of the contract. The message is written for a human and may be reworded at any time.
The ones you will meet:
A 403 for a role and a 403 for a plan are different problems with different fixes. One is answered by an Admin in your organization; the other by your account contact. The error code distinguishes them.

​
Roles

Read endpoints need Viewer. Creating and editing product configuration needs Editor. Users, license keys and billing need Admin. The audit log needs Auditor, Admin or Owner. The full model, including why Auditor is not a rung on the ladder, is on Roles and permissions.

​
Working with the API

Logs, metrics, traces and services are all queryable, with the same time ranges and filters the product uses. Results are cached briefly, so two identical requests in quick succession may return the same response — see Platform architecture.
Alert rules, dashboards, SLOs, synthetic checks and notification channels can all be created and updated programmatically — which is what makes it practical to keep them in version control and apply them per environment.Synthetic checks additionally import and export as YAML.
A subset of the Prometheus HTTP API, so Grafana can read aiAxonIQ as a datasource with no adapter. Read the limits before relying on it — rate functions parse and return an average. See Grafana and Prometheus clients.
Ingest volume against plan allowances, for your own dashboards or a monthly report. Cached for five minutes.

​
Sending telemetry

Ingest is a different surface with different rules — a license key rather than a session, its own status codes and its own limits. It is documented under Ingest endpoints rather than here.

​
Next

Authentication

The two credentials and which to use where.

Roles and permissions

What each role can reach.

Ingest endpoints

The other half of the surface.