Axonius REST API and Python API Client
  • 02 Aug 2022
  • 1 Minute to read
  • Dark
    Light
  • PDF

Axonius REST API and Python API Client

  • Dark
    Light
  • PDF

Axonius provides two ways to access the Axonius API:

  • A RESTful API service
  • A Python-wrapped API client that allows you to use the Python programming language to run REST API commands. See here for more information on installing and using the API client.

To use either API, you must have the following:

  • API Key: either a user name and password, or an API key and API secret.
  • API Access permission: The user's role used to access the API requires that the API Access permission will be enabled.

Creating a Service Account

You can also create Service Accounts to manage accounts that will only connect to the system using the API. Refer to Manage Service Accounts.

Get an API Key

Using the Axonius API to query Axonius assets requires a user name and password, or an API key and API secret.

NOTE
It is recommended to use the API key and secret.

To get an API Key and an API Secret do as follows:

  1. Open your user Account Settings.
    From the left navigation panel, under your account avatar and user name, click the Settings image.png icon.

    image.png

  2. Select the API Key tab. Copy the existing API key and secret. To reset them, click Reset Key.

    image.png

Enable API Access Permission

Using the Axonius API to query Axonius assets requires a that the user's role will have the API Access enabled permission enabled.

To set this permission:

  1. Open the Manage Roles page.
    From the top right corner of all pages, click image.png. The System Settings page opens. Then, click the Manage Roles tab.

image.png

  1. Select the relevant role as described in Manage Roles. For the selected role, under the API Access category, select the API access enabled checkbox.
    image.png

  2. Click Save.


First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.