Documentation Center
AlienVault® USM Anywhere™

API Clients

  Role Availability   Read-Only   Analyst   Manager

USM Anywhere offers a REST API framework that allows you to customize elements of data in your environment. The AlienVault 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. AlienVault uses OAuth 2.0 to authenticate against the REST APIs.

To open the API Clients page

  1. Click the icon in the upper-right corner of the USM Anywhere web UI and select PROFILE.
  2. Select the API Clients tab.
  3. API Clients main page

    Note: Click New Client to create a new client. See USM Anywhere API for further information

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

To enable an API Client

  1. Click the icon in the upper-right corner of the USM Anywhere web UI and select PROFILE.
  2. Select the API Clients tab.
  3. Locate the API Client you want to enable and click the disabled icon ().
  4. This turns the icon green (). To disable an already enabled API Client, toggle the icon to its original status.

    Enable or disable API Clients

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

To edit an API Client

  1. Click the icon in the upper-right corner of the USM Anywhere web UI and select PROFILE.
  2. Select the API Clients tab.
  3. Locate the API Client you want to modify and click the edit icon ().
  4. The Edit Client popup window displays.

    Edit Client ID popup window

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