Use the Reports API

To configure reporting tool integration, create a personal API key and then use the Reports API.

Create a personal API key

Personal API keys allow you to access Arctic Wolf APIs.

Note: Use the Unified Portal for this task, not the MSP portal. If you are a conglomerate or MSP customer, we recommend creating the PAK in the parent or MSP internal Unified Portal. If you create the PAK within a child or MSP child customer portal, the PAK will still be associated to your User permissions, not based on the Org you create the PAK in.
For more information, see Personal API keys.
  1. Sign in to the Arctic Wolf Unified Portal.
  2. In the navigation menu, click Organization Profile > Personal API Keys.
  3. Click Create an API Key.
  4. In the Name field, enter a name to identify the API key. For example, the third-party application that will use the key.
  5. In the Expiry field, select the time period after which the API key will expire.
  6. Click Create Key.
  7. Copy the token to a safe, encrypted location.
    After closing the window, you will not be able to view the token again.

Invoke the Organizations API

Invoke this API is to determine which Arctic Wolf organization ID and regions, also known as PODs, are related to your organization, also known as the tenant.

  1. Navigate to Organizations API specifications and download the specifications file.
  2. Unzip and upload the specifications file in a third-party tool, such as Postman.
  3. Query the Organizations API:
    CODE 
    https://eloc.global-prod.arcticwolf.net/api/v1/organizations

    The Organizations API provides the mapping between tenants, their corresponding regions, and organization IDs.

  4. Copy the the name of the POD and the organization ID, and then save them in a safe, encrypted location.

Invoke the Reports API

  1. Navigate to Reports API specifications and download the specifications file.
  2. Unzip and upload the specifications file in a third-party tool, such as Postman.
  3. Invoke the Reports API, using the personal API key to authenticate and the values from Invoke the Organizations API as needed.

Configure the reporting integration

Follow the instructions for your reporting tool to configure the integration.