Get an Alarm Template

In this article

    You can get a representation of a Veeam Service Provider Console alarm template with the specified ID.


    To get a representation of a specific alarm template, send the GET HTTPS request to the URL of its resource.

    HTTPS Request

    GET https://<hostname>:1280/v2/alarms/templates/{ID}

    Request Headers

    The request header must contain the authorization token.


    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.




    The length of the response body.


    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/{ID} resource.

    Example Get an Alarm Template

    The following request returns a representation of an alarm template with ID 55a68835-0a1a-4a13-8223-450477936448.


    GET https://localhost:1281/v2/alarms/templates/{ID}/55a68835-0a1a-4a13-8223-450477936448


    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"