Skip to main content

Authenticate Alert API

The Alert API is authenticated using an API key, which is a unique identifier associated with your organization. You generate the key in Risk Monitor and include your API key as an HTTP header.

You can only have one active API key for your organization. Each key is valid for three months after activation.

Add API key as HTTP header

To authenticate the Alert API, you include your API key in an HTTP header.

  1. In the Configuration view, select Alerting & API and then the Setup tab.

  2. In the API Authentication section, copy x-api-key from Header Name.

  3. Include x-api-key as an HTTP header for the Alert API call.

  4. In the API Authentication section, select Copy from the table below New Key to copy the currently active API key.

    If there is no active API key available, generate a new one. See Generate API key.

  5. Paste the API key in as the value for the HTTP header x-api-key.

Generate API key

  1. In the Configuration view, select Alerting & API and then the Setup tab.

  2. In the API Authentication section, select New Key.

    A new row appears at the top of the table below New Key with the details of the active API key.

In this section: