Skip to main content
Role Availability | ❌ Read-Only ❌ Analyst ✔️ Manager USM Central offers a Representational State Transfer (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 need to create a client identification (ID) and secret code in the USM Central interface, and use that information to create a token. USM Central uses Open Authorization (OAuth) 2.0 to authenticate against the REST APIs.
Edition: The API is available in the Standard and Premium editions of USM Anywhere.See the Affordable pricing to fit every budget page for more information about the features and support provided by each of the USM Anywhere editions.
To open the API Clients page
  • At the bottom of the expanded pane of the USM Central web user interface (UI), hover over the icon and select Profile Settings > API Clients.
To create a new API client
  1. Click New Client.
  2. In the Create New Client pop-up box, enter the client ID in the text box.
  3. Click Create Client.
    Note: Only users with the Manager role are allowed to create new API clients.
    Tip: On the New Client Created pop-up box, hover over the secret key to copy the texts to your clipboard. Save this secret key for future use and reference.
To edit an API Client
  1. At the bottom of the expanded pane of the USM Central web user interface (UI), hover over the icon and select Profile Settings > API Clients.
  2. Click the Edit icon of the corresponding client ID you want to edit.
  3. On the Edit Client pop-up box, enter the new client ID, and then click Update Client.
To delete an API Client
  1. At the bottom of the expanded pane of the USM Central web user interface (UI), hover over the icon and select Profile Settings > API Clients.
  2. Locate the API client that you want to delete and click Delete Client. The delete client dialog box opens.
  3. Click Delete Client.