Skip to main content

Authorization

Follow this guide to create a new Axonius API credential that will allow Nexla to authenticate to and exchange data with your Axonius instance.
axonius_api_auth.png

Axonius API

Prerequisites​

Before creating an Axonius API credential, you'll need to obtain API credentials from your Axonius instance. Axonius uses API key and client secret authentication for API access.

Axonius API Credentials Setup​

To obtain the required API credentials for Axonius API access:

  1. Log in to Axonius: Access your Axonius instance using your administrator credentials.

  2. Navigate to API Settings:

    • Go to Settings > API (or Administration > API Settings)
    • Locate the API credentials section

  3. Generate API Credentials:

    • Click Create API Key or Generate Credentials to create a new API key pair
    • You'll receive:
      • API Key: A unique identifier for API authentication
      • Client Secret: A confidential key used for authentication
    • Copy both values immediately, as the client secret may only be displayed once

  4. Note Your Axonius Host URL:

    • Record your Axonius instance URL (e.g., https://your-instance.axonius.com or https://axonius.yourdomain.com)
    • This is the base URL for your Axonius deployment

Axonius API credentials are specific to your Axonius instance and should be kept secure. The API key and client secret are used together for authentication via custom headers. For detailed information about Axonius API authentication, refer to your Axonius instance documentation or contact your Axonius administrator.

API Access Requirements​

Axonius API access requires:

  • Axonius Instance Access: You must have access to an Axonius deployment
  • Administrator Permissions: API credential generation typically requires administrator-level access
  • API Key and Secret: Both the API key and client secret are required for authentication
  • Network Access: Ensure your network allows connections to your Axonius instance URL

Create an Axonius API Credential​

To create a new Axonius API credential:

  1. Create a new data flow, and select the Axonius connector.

  2. Under the Configure section in the data source configuration screen, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Axonius

AxoniusCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Axonius API Credentials Configuration​

  1. Axonius Host URL: Enter the base URL for your Axonius instance in the Axonius Host URL field. This should be the complete URL including the protocol (https://) and your Axonius instance domain (e.g., https://your-instance.axonius.com or https://axonius.yourdomain.com).

  2. Axonius API Key: Enter the API key obtained from your Axonius instance in the Axonius API Key field. This unique identifier is used for API authentication.

  3. Axonius Client Secret: Enter the client secret obtained from your Axonius instance in the Axonius Client Secret field. This confidential key is used together with the API key for authentication.

The API key and client secret are sensitive information that should be kept secure. Nexla will store these credentials securely and use them only for API authentication purposes. Both credentials are sent as custom headers (api-key and api-secret) with each API request.

Authentication Configuration Details​

Axonius API uses header-based authentication with API key and client secret. This configuration is automatically handled by Nexla:

  • Authentication Type: Header-based authentication
  • Headers: api-key and api-secret headers are automatically included in all API requests
  • Request Format: All API requests use JSON content type

The authentication configuration is automatically managed by Nexla. You only need to provide your Axonius Host URL, API Key, and Client Secret.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.