Docs
DocumentationQuery ReferenceAPI Reference
Open Console→→
DocumentationQuery ReferenceAPI Reference

Get started

IntroductionSend dataQuery dataPaginationAPI limits

Annotations

List all annotationsGETRetrieve annotationGETCreate annotationPOSTUpdate annotationPUTDelete annotationDELETE

API tokens

List all API tokensGETRetrieve API tokenGETCreate API tokenPOSTRegenerate API tokenPOSTDelete API tokenDELETE

Dashboards

List all dashboardsGETRetrieve dashboardGETCreate dashboardPOSTUpdate dashboardPUTPatch dashboard elementPATCHDelete dashboardDELETE

Datasets

List all datasetsGETRetrieve datasetGETList all fields in datasetGETRetrieve field in datasetGETCreate datasetPOSTIngest data (legacy)POSTRun queryPOSTRun query (legacy)POSTTrim datasetPOSTUpdate datasetPUTUpdate fieldPUTVacuum datasetPOSTDelete datasetDELETE

Edge

Ingest data to edge deploymentIngest Splunk HEC eventsIngest raw Splunk HEC eventsCheck Splunk HEC healthRun APL query to edge deploymentRun batch query to edge deploymentRun MPL query to edge deploymentGet metrics for a datasetGet metric tags for a datasetGet metric tag values for a datasetGet tags for a datasetGet tag values for a dataset

Map fields

List all map fieldsGETCreate map fieldPOSTUpdate list of map fieldsPUTDelete map fieldsDELETE

Monitors

List all monitorsGETRetrieve monitorGETRetrieve monitor historyGETCreate monitorPOSTUpdate monitorPUTDelete monitorDELETE

Notifiers

List all notifiersGETRetrieve notifierGETCreate notifierPOSTUpdate notifierPUTDelete notifierDELETE

Organizations

List all orgsGETRetrieve orgGETCreate orgPOSTUpdate orgPUTProvision orgPOST

Role-based access control

List all rolesGETRetrieve roleGETList all groupsGETRetrieve groupGETCreate rolePOSTCreate groupPOSTUpdate rolePUTUpdate groupPUTDelete roleDELETEDelete groupDELETE

Saved queries

List all saved queriesGETRetrieve saved queryGETCreate saved queryPOSTUpdate saved queryPUTDelete saved queryDELETE

Users

Retrieve current userGETList all usersGETRetrieve userGETCreate userPOSTUpdate current userPUTUpdate user rolePUTDelete user from orgDELETE

Views

List all viewsGETRetrieve viewGETCreate viewPOSTUpdate viewPUTDelete viewDELETE

Virtual fields

List all virtual fieldsGETRetrieve virtual fieldGETCreate virtual fieldPOSTUpdate virtual fieldPUTDelete virtual fieldDELETE
Get started

API limits

Learn how to limit the number of calls a user can make over a certain period of time.

Axiom limits the number of calls a user (and their organization) can make over a certain period of time to ensure fair usage and to maintain the quality of service for everyone. Axiom systems closely monitor API usage and if a user exceeds any thresholds, Axiom temporarily halts further processing of requests from that user (and/or organization). This is to prevent any single user or app from overloading the system, which could potentially impact other users' experience.

Rate Limits

Rate limits vary and are specified by the following header in all responses:

HeaderDescription
X-RateLimit-ScopeIndicates if the limits counts against the organisation or personal rate limit.
X-RateLimit-LimitThe maximum number of requests a user is permitted to make per minute.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.

Possible values for X-RateLimit-Scope :

  • user
  • organization

When the rate limit is exceeded, an error is returned with the status "429 Too Many Requests":

JSON
{
    "message": "rate limit exceeded",
}

Query Limits

HeaderDescription
X-QueryLimit-LimitThe query cost limit of your plan in Gigabyte Milliseconds (GB*ms).
X-QueryLimit-RemainingThe remaining query Gigabyte Milliseconds.
X-QueryLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.

Ingest Limits

HeaderDescription
X-IngestLimit-LimitThe maximum bytes ingested a user is permitted to make per month.
X-IngestLimit-RemainingThe bytes ingested remaining in the current rate limit window.
X-IngestLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.

Alongside data volume limits, Axiom also monitors the rate of ingest requests. If an organization consistently sends an excessive number of requests per second, far exceeding normal usage patterns, Axiom reserves the right to suspend their ingest to maintain system stability and ensure fair resource allocation for all users. To prevent exceeding these rate limits, it’s highly recommended to use batching clients, which can efficiently manage the number of requests by aggregating data before sending.

Limits on ingested data

For more information on limits and requirements imposed by Axiom, see Limits.

Was this page helpful?
Suggest edits on GitHub
PreviousPagination in Axiom APINextList all annotations
On this page
Rate LimitsQuery LimitsIngest LimitsLimits on ingested data