Introduction

🚧
You need a third party token (TPT) to interact with the Inarix API.

Conventions

The base URL to send all API requests is https://api.inarix.com. HTTPS is required for all API requests.

The Inarix API follows RESTful conventions when possible, with most operations performed via GET, POST, PUT, PATCH, and DELETE requests. Request and response bodies are encoded as JSON.

JSON CONVENTIONS

Property names are in camelCase (not snake_caseor kebab-case).
Temporal values (dates and datetimes) are encoded in ISO 8601 strings. Datetimes will include the time value (2020-08-12T02:12:33.231Z) while dates will include only the date (2020-08-12).
Timezone is always UTC

Pagination

Endpoints that return lists of objects support page-based pagination requests. By default, Inarix returns one thousand items per API call.

RESPONSES

Field	Type	Description
total	number	Total number of objects to fetch.
limit	number	Maximum number of objects per page.
skip	number	The number of objects skipped to fetch the current page.
data	array of objects	The list, or partial list, of endpoint-specific results.

Status Codes

HTTP response codes are used to indicate general classes of success and error.

Success Code

HTTP Status Quote	Description
200	Successfully processed request.
201	Object successfully created. For some specific services, it can also mean successfully processed request.

Error Codes

Error responses contain more detail about the error in the response body, in the "name" and "message"properties.

HTTP Status Code	message
400	The request could not be successfully processed.
401	Your token is expired.
403	You don’t have the permissions to perform this request.