Get Triggered Alarms

In this article

    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 for the current logon session.

    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.

    Request:

    GET https://localhost:1281/v2/notifications/events?startTime=2019-4-1&endTime=2019-5-1

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    [

     {

       "id": 1,

       "alarmTemplateId": 12,

       "repeatCount": 1,

       "companyId": 4,

       "locationId": 4,

       "computerName": "srv21",

       "objectName": "srv21",

       "lastActivation": {

         "time": "2018-11-23T08:54:56.9967505Z",

         "status": "Resolved",

         "message": "All metrics are back to normal.\r\n",

         "remark": "Automatically resolved.\r\n"

       },

       "_links": [

         {

           "rel": "self",

           "method": "GET",

           "href": "https://vac:1281/v2/notifications/events/1"

         },

         {

           "rel": "related",

           "method": "GET",

           "href": "https://vac:1281/v2/notifications/alarmTemplates/12"

         }

       ]

     },

     {

       "id": 2,

       "alarmTemplateId": 15,

       "repeatCount": 7,

       "companyId": 1,

       "locationId": 0,

       "computerName": "srv49",

       "objectName": "srv49",

       "lastActivation": {

         "time": "2018-11-26T10:34:45.6049307Z",

         "status": "Error",

         "message": "ConnectWise Manage plugin failed to contact Veeam Availability Console. Review debug logs for more information.\r\n",

         "remark": "\r\n"

       },

       "_links": [

         {

           "rel": "self",

           "method": "GET",

           "href": "https://vac:1281/v2/notifications/events/2"

         },

         {

           "rel": "related",

           "method": "GET",

           "href": "https://vac:1281/v2/notifications/alarmTemplates/15"

         }

       ]

     }

    ]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.