Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Get an Alarm Template

You can get a representation of a Veeam Availability 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://<Availability-Console>:1281/v2/notifications/alarmTemplates/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

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 Availability Console returns a representation of the /notifications/alarmTemplates/{ID} resource.

Example Get an Alarm Template

The following request returns a representation of an alarm template with the specified ID.


GET https://localhost:1281/v2/notification/alarmTemplates/1


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:


 "id": 1,

 "name": "Job state",

 "category": "VM job",

 "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."


 "predifined": true,

 "enabled": true,

 "_links": [


     "rel": "self",

     "method": "GET",

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



     "rel": "related",

     "method": "GET",

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




Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference