Properties

In this article

    The resources in the /notifications/alarmTemplates and /notifications/events collections have properties that represent alarms settings in Veeam Service Provider 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 the Veeam Service Provider Console REST 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 Service Provider 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 the Veeam Service Provider Console REST API.

    alarmTemplateId

    integer

    System ID assigned to an alarm template in the Veeam Service Provider Console REST API.

    repeatCount

    integer

    Number of times that the alarm changed its status.

    companyId

    integer

    System ID assigned to a company in Veeam Service Provider 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 — comment to the resolved alarm

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).