Axonius REST API

Use the Axonius REST API to perform tasks within the Axonius platform rather than the User Interface.

Key Features of API v2:

• Streamlined Endpoints - The initial release includes around 40 endpoints, each focused on the most vital parameters needed to achieve your goals. More endpoints will be added over time.
• Standardized and Developer-Friendly - The new API adheres to industry standards, making it easier to use and developer-friendly, which in turn speeds up development for Axonius developers.
• Comprehensive Documentation - Our detailed and cohesive documentation helps users quickly understand which endpoints to use and how to write the necessary code to achieve their objectives.
• Clear Error Messages - Clear and simple error messages, making it easier to understand and resolve issues.

📘

Using a Service Account for REST API Access

The REST API is only accessible using a service account dedicated for API access. The service account must be assigned a role that has permission to access the API and the permissions to perform those tasks it will execute via the API. You can also use multiple service accounts to compartmentalize access.

For users of Axonius v6.1.73 and earlier, a regular user account can still be used as well as service accounts.

Accessing the API v2 Documentation

For access to our API v2 documentation, see Axonius API v2 documentation.

• Enter your email (work email) and click on Send Login Link

If you do not have access to the API v2 documentation or are facing problems, open a Zendesk ticket and select the API v2 option to request access.

Accessing the API v2 Documentation for Axonius Federal Users

Open a ticket via the Federal Support Portal or email your request to [email protected] with the subject "Access to APIv2 documentation".

Federal Customers should not open a support request at https://support.axonius.com.