Skip to main content

Get Alert DefinitionsDetails​

Get details of alert definition

Path Parameters
  • id int32 required
Query Parameters
  • additionalProperties boolean
Responses

Success

Schema
  • id int32
  • name string
  • alertSummary object
  • type object
  • id int32

    id of the alert definition

  • name string

    Possible values: [Clients, Edge drive-Share operations, License, MediaAgents, Users, Client Group License Usage Check, Data aging is disabled for n days, Expiring clones, Index Backup Status, Index State, Notify decommissioned Virtual Machines, Auxiliary Copy, Data Aging, Data Protection, Data Recovery, DeDup DB Reconstruction, Disaster Recovery Backup, Device Status, Library Management, Admin Alert, Event Viewer Events, Updates Available to Download, No DDB Verification Job in last n days, HyperScale-HardwareAlerts, Replication]

    type of the alert definitions

  • category object
  • id int32

    id of the category of the alert definition

  • name string

    Possible values: [Configuration, Custom Rules, Job Management, Media Management, Operation, Software Updates]

    category of the alert definition

  • criteria object
  • id int32

    id of the criteria of detection for the alert definition

  • name string

    Possible values: [Backup Job Failed, Backup Job Skipped, Backup Job Succeeded, Increase in Data size by n percent for backup job, Backup Job Activity, Backup Delayed by n Hrs, Backup Job completed with Errors, Backup Job Started, No Backup for last n Days, Restore Job Failed, Restore Job Skipped, Restore Job Succeeded, Restore Job Activity, Restore Job Started, Restore Job completed with Errors, Disk space low on client, Failover started, Failover activity, Failover completed, Failover failed, Production Commserve is not reachable, Production Commserve is not running, Passive node is not reachable, May miss SLA, VM Backup succeeded, VM Backup failed, VM Backup succeeded with errors, Missed SLA, Replication Delayed by n Hrs, No Replication in last n Days, In Sync, Sync Pending, Sync Paused, Sync Failed, Failover Failed, Failover Complete, Failback Failed, Undo Failover Failed]

    criteria of detection for the alert definition

  • paramsList object[]
  • unit int32

    Unit of the criteria(For eg. :Hrs,min)

  • type int32

    Input value type (default 0 = no input required)

  • value int32

    Value of the criteria (deefault 0 : if no value required)

  • paramIndex int32

    Param order index

  • sendIndividualNotifications boolean

    true if individual notifications are on for the alert definitions

  • processDiscoveredVMs boolean

    Set to true for all Virtual Machine related alerts.

  • associations object[]
  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [ALL_SERVERS, ALL_SERVER_GROUPS_ENTITY, SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY, SUBCLIENT_ENTITY, REPLICATION_PAIR_ENTITY, BLR_PAIR_ENTITY, FS_REPLICATION_PAIR_ENTITY]

  • parentEntity1 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • parentEntity2 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • parentEntity3 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • parentEntity4 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • alertTarget object

    Please note CONTENT_INDEX will be returned at all times as it is enabled at all times.

  • sendAlertTo string[]

    Possible values: [LIVEFEEDS, SNMP, WEBHOOK, EMAIL, APPLOG, CONTENT_INDEX]

  • recipientsOperationType string

    Possible values: [ADD, DELETE, OVERWRITE]

    Allows adding to, overwriting and deleting existing recipients. default is adding to existing recipients

  • recipients object
  • to object[]
  • id int32
  • name string
  • type string

    Possible values: [USER, USER_GROUP, EMAIL, AD_USERGROUP]

  • cc object[]
  • id int32
  • name string
  • type string

    Possible values: [USER, USER_GROUP, EMAIL, AD_USERGROUP]

  • bcc object[]
  • id int32
  • name string
  • type string

    Possible values: [USER, USER_GROUP, EMAIL, AD_USERGROUP]

  • webHookId int32

    id of the webhook to be associated with the alert definition. Only needed incase of webhook notif selected. To get a list of webhooks, use api GET Webhook

  • templates object
  • locale object
  • id int32
  • name string
  • email string

    the message template for the email notification. Contains both email subject as well as body

  • console string

    the message template for the console notification

  • eventViewer string

    the message template for the event viewer notification

  • webhook string

    the message template for the webhook notification

  • additionalProperties object
  • status int32

    Tells status of alert. Can be used to find if alert is enabled or not.

Loading...