Skip to main content

Include API version

To use the Risk Monitor Alert API, you must include a valid version of the Alert API in all HTTP requests. If the Alert API is later changed, and to mitigate against breaking changes, new functionality will be implemented in a new version.

You add the relevant API version using an HTTP header in the HTTP GET requests.

Add API version as HTTP header​

  1. Include x-api-version as an HTTP header for the Alert API call.

  2. Enter the API version as the value for x-api-version.

    If you do not know what versions are supported, see Find supported API versions.

Find supported API versions​

  • Send an HTTP request to the List or Download token endpoint. For more information, see Alert API.

    The HTTP header api-supported-versions is included in the response with values for the supported versions.