Getting Started

Introduction

The Axiom API gives full control over the entire Axiom platform

API Basics

All our endpoints live under the url https://cloud.axiom.co/api and follow the REST architectural style.

Content Type

All requests must be encoded as JSON with the Content-Type header set to application/json. If not otherwise specified, responses from the Axiom API, including errors, are encoded exclusively as JSON as well.

Authentication

Requests to the Axiom API must provide an API token through the Authorization header:

Authorization: Bearer <$API_TOKEN or $PERSONAL_TOKEN>

The Authorization header with an access token.

API Tokens can be created and managed from Settings --> API Tokens on Axiom UI

API Tokens are used to ingest, and query data and are tied to a specific organization.
Personal Tokens grant access to all API resources available to the user, but require the X-Axiom-Org-ID header when used with organization-specific endpoints (like ingest and querying).

Types

The following is a list of the types of data used within the Axiom API:

Name	Definitions	Example
ID	A unique value used to identify resources.	"io12h34io1h24i"
String	A string is a sequence of characters used to represent text.	"string value"
Boolean	A Boolean is a type of two possible values representing true or false.	true
Integer	An integer is a number without decimals.	4567
Float	A float is a number with decimals.	15.67
Map	A data structure with a list of values assigned to a unique key.	{ "key": "value" }
List	A data structure with only a list of values separated by a comma.	["value", 4567, 45.67]