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

Properties

The resources in the /notifications/alarmTemplates and /notifications/events collections have properties that represent alarms settings in Veeam Availability Console. Depending on these settings, resources can have different sets of properties.

Alarm Templates

The resources in the /notifications/alarmTemplates collection have a number of properties that reflect alarm template characteristics. Properties can be used as query parameter values in GET requests.

Property

Type

Description

id

integer

System ID assigned to an alarm in Veeam Availability Console RESTful API.

name

string

Name of an alarm.

category

string

Indicates an object type of an alarm.

internalId

integer

System ID assigned to an alarm template in Veeam Availability Console internal alarm database.

knowledge

string

Indicates knowledge base for an alarm.

Includes the following sections:

  • summary — general description of an alarm
  • cause — possible causes of an alarm trigger
  • resolution — recommended solutions

predifined

boolean

Indicates whether the alarm is predefined or custom.

enabled

boolean

Indicates whether the alarm is enabled or disabled.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Triggered Alarms

The resources in the /notifications/events collection have a number of properties that reflect triggered alarm characteristics. Properties can be used as query parameter values in GET requests.

Property

Type

Description

id

integer

System ID assigned to a triggered alarm in Veeam Availability Console RESTful API.

alarmTemplateId

integer

System ID assigned to an alarm template in Veeam Availability Console RESTful API.

repeatCount

integer

Number of times that the alarm changed its status.

companyId

integer

System ID assigned to a company in Veeam Availability Console.

locationId

integer

System ID assigned to a location of a company.

computerName

string

Name of an affected site.

objectName

string

Name of an object that caused the alarm.

lastActivation

string

Indicates information about the last time the alarm was triggered.

Includes the following sections:

  • time — date and time of the alarm trigger
  • status — alarm status
  • message — the cause of the alarm trigger
  • remark — the cause of the alarm trigger

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference