This is an archive version of the document. To get the most up-to-date information, see the current version.

Get Triggered Alarms

You can get a representation of a collection of Veeam Service Provider Console triggered alarms for the specified time period.

Request

To get a representation of all Veeam Service Provider Console active alarms, send the GET HTTPS request to the URL of the /notifications/events collection. Additionally you must create a query string that contains start date and end date timestamps in the YYYY-MM-DD format to limit searched items.

HTTPS Request

GET https://<hostname>:1281/v2/notifications/events?startTime={Date}&endTime={Date}

Request Headers

The request header must contain the authorization token.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a representation of the /notifications/events collection.

Example Get Triggered Alarms

The following request returns a short representation of all triggered alarms for the specified period configured in Veeam Service Provider Console.