Apply REST API credentials to monitor REST API information reported by a service or services on a RESTful endpoint.

Configure the following fields to begin creating a REST API credential:

  • Name. Enter a unique name for the credential. This name displays in the Credentials Library.
  • Description. Enter an optional description with additional detail, if desired.
  • Auth Type. Select the method of authentication required for REST API access.

Basic Authentication

When Basic Authentication is selected, configure the following:

  • User Name. User name needed to authenticate to the device.
  • Password. Password associated with the user name.
  • Confirm password. Re-enter the authentication password for confirmation.

OAuth 2.0

When OAuth 2.0 is selected, the user must have previously acquired the Token URL, Client ID, and Client Secret from the OAuth2 authentication server to be accessed from the WhatsUp Gold REST API monitors. Configure the following:

  • Grant Type. Select either Client Credentials , Password Grant, or Authorization Code.
  • Token URL. The address or root of the authentication server generated by the authentication server.
  • User Name. The user name required to access the authentication server.
  • Password. The password required to access the authentication server.
    Note: User Name and Password are used when Password Grant is selected as the Grant Type.
  • Client ID. Enter the public client identifier assigned to WhatsUp Gold by the authentication server.
  • Client Secret. Enter the client secret generated by the authentication server required for application identification.
  • Scope. Enter the value needed to determine the level of access permitted.

After your OAuth 2.0 configuration settings have been entered, click Test for confirmation that your entries are valid and authorization can be granted.

If applicable, under Additional Parameters, click the Add icon to include any optional vendor-specific variables needed for successful authentication. Any variables previously added to the REST API credential may also be edited or removed using the additional controls provided.