Documentation Center
AlienVault® USM Anywhere™

API Clients

Role Availability Read-Only Analyst Manager

USM Anywhere offers a REST API framework that enables you to customize elements of data in your environment. The APIs return JSON responses with errors that use HTTP response codes. To access the API, you will need to create a client ID and secret code in the USM Anywhere interface, and use that information to create a token. USM Anywhere uses OAuth 2.0 to authenticate against the REST APIs.

Edition: API is available in the Standard and Premium editions of USM Anywhere.

For more information about the feature and data support provided by each of the USM Anywhere editions, go to https://www.alienvault.com/pricing.

To open the API Clients page

  1. In the upper right corner of the USM Anywhere web UI, click the icon and select Profile.
  2. Select API Clients.
  3. API Clients main page

  4. Click New Client to create a new client. See USM Anywhere API for more information.

To enable an API Client

  1. In the upper right corner of the USM Anywhere web UI, click the icon and select Profile.
  2. Select API Clients.
  3. Locate the API client that you want to enable and click the icon. This turns the icon green. To disable an already enabled API Client, toggle the icon to its original status.
  4. Enable or disable API Clients

    Note: See USM Anywhere API for more information about how to reset the API Client ID.

To edit an API Client

  1. In the upper right corner of the USM Anywhere web UI, click the icon and select Profile.
  2. Select API Clients.
  3. Locate the API client that you want to modify and click the icon to open a new window.
  4. Edit Client ID popup window

  5. Make changes to the client ID, as needed.
  6. Click Update Client.