Get Alarm Status Changes

In this article

    You can get a representation of all status changes of a triggered alarm with the specified template ID.

    Request

    To get a representation of the last time an alarm was triggered, send the GET HTTPS request to the URL of its resource.

    HTTPS Request

    GET https://<hostname>:1281/v2/notifications/alarmTemplates/{ID}/events

    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/alarmTemplates/{ID}/events resource. The id parameter represents the triggered alarm ID while the alarm template ID is represented by the alarmTemplateId parameter.

    Example Get Alarm Status Changes

    The following request returns a representation of a last time an alarm with the alarm template ID 16 was triggered.

    Request:

    GET https://localhost:1281/v2/notification/alarmTemplates/16/events

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    [

     {

       "id": 1,

       "alarmTemplateId": 16,

       "repeatCount": 1,

       "companyId": 4,

       "locationId": 4,

       "computerName": "srv21",

       "objectName": "srv21",

       "lastActivation": {

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

         "status": "Error",

         "message": "State of Backup Server \"srv21\" is Inaccessible.\r\n",

         "remark": "\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/16"

         }

       ]

     },

     {

       "id": 2,

       "alarmTemplateId": 16,

       "repeatCount": 1,

       "companyId": 4,

       "locationId": 4,

       "computerName": "srv28",

       "objectName": "srv28",

       "lastActivation": {

         "time": "2018-11-26T16:57:42.8842349Z",

         "status": "Error",

         "message": "State of Backup Server \"srv28\" is Inaccessible.\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/16"

         }

       ]

     }

    ]

    I want to report a typo

    There is a misspelling right here:

     

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