Get Alarm Templates

In this article

    You can get a short representation of a collection of Veeam Service Provider Console alarm templates.

    Request

    To get a representation of all Veeam Service Provider Console alarm templates, send the GET HTTPS request to the URL of the /alarms/templates collection.

    HTTPS Request

    GET https://<hostname>:1280/v2/notifications/alarmTemplates

    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 /alarms/templates collection.

    Example Get Alarm Templates

    The following request returns a short representation of all alarm templates in Veeam Service Provider Console.

    Request:

    GET https://localhost:1281/v2/alarms/templates

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    [

     {

       "instanceUid": "55a68835-0a1a-4a13-8223-450477936448",

       "name": "Job state",

       "category": "VM job",

       "unitUid": "6cf682b3-8195-4954-a4bb-c1c68b6c41ff",

       "internalId": 1,

       "knowledge": {

         "summary": "Job is in a disabled state for more than allowed time period.",

         "cause": "Veeam Backup & Replication server allows to disable scheduled backup jobs during maintenance windows. If backup job stays in a disabled state for more than allowed time period, it should be enabled back.",

         "resolution": "Open Veeam Backup & Replication console and enable all disabled backup jobs."

       },

       "isPredifined": true,

       "isEnabled": true,

       "_links": [

         {

           "rel": "self",

           "method": "GET",

           "href": "https://vac:1281/v3/alarms/templates/1"

         },

         {

           "rel": "related",

           "method": "GET",

           "href": "https://vac:1281/v3/alarms/templates/1/events"

         }

       ]

     },

     {

       "instanceUid": "dd20b164-9008-456b-9e2e-dcafa5a29072",

       "name": "Max allowed job duration",

       "category": "VM job",

       "unitUid": "5a800a20-a4bb-4141-b2fd-f966574e523f",

       "internalId": 2,

       "knowledge": {

         "summary": "Job has exceeded its allowed execution time.",

         "cause": "Veeam job has exceeded the configured threshold of maximum allowed job duration.",

         "resolution": "Verify that VMware CBT was used for all VMs in the configured backup/replication job. Check the number of read and transferred data blocks for each VM, make sure your Veeam proxy servers have sufficient number of concurrently running tasks allowed. Alternatively, adjust the maximum allowed job duration threshold for this alarm."

       },

       "isPredifined": true,

       "isEnabled": true,

       "_links": [

         {

           "rel": "self",

           "method": "GET",

           "href": "https://vac:1281/v3/alarms/templates/2"

         },

         {

           "rel": "related",

           "method": "GET",

           "href": "https://vac:1281/v3/alarms/templates/2/events"

         }

       ]

     }

    ]