Getting Started with Axiom API (Preview)

Introduction

The Axiom API is a REST-styled API that gives full control over the entire Axiom platform.

You can use the commands with curl by providing your Access Token

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.

Failed Authentication

If authentication is unsuccessful for a request, the error status code 403 is returned.

Types

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

NameDefinitionsExample
IDA unique value used to identify resources."io12h34io1h24i"
StringA string is a sequence of characters used to represent text."string value"
BooleanA Boolean is a type of two possible values representing true or false.true
IntegerAn integer is a number without decimals.4567
FloatA float is a number with decimals.15.67
MapA data structure with a list of values assigned to a unique key.{ "key": "value" }
ListA data structure with only a list of values separated by a comma.["value", 4567, 45.67]

Was this page helpful?