Axonius Integration

Generating Axonius API Credentials

Confirm API access is enabled for your role

1. In Axonius, go to System Settings (gear icon) → User and Role Management → Roles.

   

2. Select the relevant role and ensure API access enabled is turned on.

3. Save.

4. Create or select an account for API use.

Get the API Key & API Secret

Individual account

Click your avatar → User Settings → API Key → Reset Key to generate a new API Key and one-time API Secret.

Service account

System Settings → User and Role Management → Service Accounts → select account → Reset to generate a new API Key and one-time API Secret.

Identify your Base URL

Use the URL of your Axonius instance, including scheme and port (e.g., https://my-axonius-instance.com:443/).

Adding Permissions for Asset Inventory

Confirm API Access

1. Login to Axonius and navigate to System Settings (gear icon) → User and Role Management → Service Accounts.

   

2. Open the account whose API key/secret is in Compyl and note its Role and Data Scope. API calls only see that data scope.

   
   
   

   ❗

   The role must already have Access → API Access → Enable API access. If it does not, the key will not work for REST at all.
   

Add Permissions to Role

1. Navigate to User and Role Management → Roles and select the proper role to edit it.
2. Adjust your asset5 permissions per type, following the table below:

   Compyl collector	Axonius permission	API
   Devices	Assets → Devices → View devices	POST /api/v2/assets/devices
   Asset Users	Assets → Users → View users	POST /api/v2/assets/users
   Software	Assets → Software → View (same View permission on the Software asset type)	POST /api/v2/assets/software
   Vulnerabilities	Assets → Vulnerabilities → View	POST /api/v2/assets/vulnerabilities
   Vulnerability Instances	Assets → Vulnerability Instances → View	POST /api/v2/assets/vulnerability_instances
   Adapters	Adapters → Adapters → View	GET /api/adapters (collector); probe is GET /api/adapters/list

3. Save the role.

Add Configuration

1. Navigate to the Integrations tab using the left-hand menu, find Axonius, and select +Add Configuration.

   

2. Next, fill in the details below and select Continue.

   

   
   Name: Enter the name of the integration

   is Enabled: Toggle button to ensure data is populated into Compyl

   Base URL: The full Base URL for your Axonius instance (e.g., https://my-axonius-instance.com:443/).

   API Key: The API Key you generated above

   API Secret: The API Secret you generated above

   Folder ID: (optional) Provide the Folder ID for saved queries you want Compyl to import.

   Historical: Toggle to retain historical Axonius query results across scheduled runs.

   

   
   Cron: Select how often to run this integration:

   • Daily: 0 0 * * * – every day at midnight UTC

   • Weekly: 0 0 * * 0 – every Sunday at midnight UTC

   • Monthly: 0 0 1 * * – on the 1st of each month at midnight UTC

     📘

     Note

     Fields and helper text mirror the Axonius configuration model in Compyl. Ensure the Base URL includes the trailing slash.

3. Choose your Endpoints and Begin Validation to validate your connection.

   

4. Select any Blueprints you wish to associate with this integration.

   

5. After you hit Continue, you'll see a summary screen. Click Return to Integrations to complete the configuration.

   

Once you have completed filling out the form click Return to Integrations.

You'll know the integration is successfully added when the status updates to Complete.

Data is synced on a recurring schedule configured by your Compyl administrator. Each sync pulls the latest data from all enabled endpoints.

To query the data from the integration, refer to the Blueprints article.