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

Get Alarm Templates

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

Request

To get a representation of all Veeam Availability Console alarm templates, send the GET HTTPS request to the URL of the /notifications/alarmTemplates collection.

HTTPS Request

GET https://<Availability-Console>:1281/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 Success.

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 Availability Console returns a representation of the /notifications/alarmTemplates collection.

Example Get Alarm Templates

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

Request:

GET https://localhost:1281/v2/notifications/alarmTemplates

 

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"

     }

   ]

 },

 {

   "id": 2,

   "name": "Max allowed job duration",

   "category": "VM job",

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

   },

   "predifined": true,

   "enabled": true,

   "_links": [

     {

       "rel": "self",

       "method": "GET",

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

     },

     {

       "rel": "related",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/2/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