About Automox API

The Automox API is a powerful interface that allows you to integrate Automox reporting data into your applications and control your devices, policies, and configurations.

All endpoints are only accessible via HTTPS and are located at https://console.automox.com/api/....

Pagination

For API endpoints that list results–like events and servers–there is a limit on the number of results returned per request. This is done for performance reasons. These endpoints have two parameters you should use to navigate your data:

Limit

A limit on the number of results to be returned, between 1 and 500 with a default of 500. A validation error will be returned if you attempt a request with a limit value that is outside this range.

Page

The page of results you wish to be returned with page numbers starting at `0`.

Examples: For example, if you have 145 servers and wish to fetch them in chunks of 50 you would have to make three requests:

/api/servers?o=<org_id>&limit=50&page=0 /api/servers?o=<org_id>&limit=50&page=1 /api/servers?o=<org_id>&limit=50&page=2

Since the Automox API does not return pagination information with all of its API endpoints, you may need to compare the number of returned results to the `limit` requested. When the limit and number of results returned are equal, you may need to make an additional request with a higher page number to ensure you have all of your data.

See our Community page example: Example API call with pagination limits

Automox Terminology

Note that ‘servers’ and ‘endpoints’ are used interchangeably.

Keep API Keys Secure!

Depending on your role, your API key may be able to modify users, devices, and policies. API keys should be kept secure and not shared to prevent unforeseen changes or potential security issues. Never email or write down your API key.

Authentication

The API key is a unique identifier that authenticates requests. You can find your API key from the console.

  • Go to Settings > Keys to find and manage your API key. Refer to Managing Keys in our documentation.

See also Getting Started with Automox API.