Get Alert DefinitionsDetails

Select

SaaS

Customer Managed

Get details of alert definition

Path Parameters

id int32 required

Query Parameters

additionalProperties boolean

Responses

Success

application/json

Schema
Example (from schema)

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.
subscriptionBasedAlert boolean
Flag to indicate whether its a subscription based alert.
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, MEDIA_AGENT_ENTITY, ALL_MEDIA_AGENTS]
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.
tokens object
match string
Possible values: [AND, OR, IS_RULE, IS_DATE, IS_TIME, BETWEEN, NOT_BETWEEN]
ruleGroups object[]
List of rule groups
match string
Possible values: [AND, OR, IS_RULE, IS_DATE, IS_TIME, BETWEEN, NOT_BETWEEN]
rules object[]
List of rules
tokenName string
Possible values: [SUBJECT END, SUBJECT BEGIN, COMMCELL NAME, ALERT CATEGORY - ALERT TYPE, TIME, UTC_TIME, OWNER NAME, OWNER EMAIL, ALERT ID, ALERT NAME, DETECTED CRITERIA, STATUS, CLIENT LIST, ATTACHMENT, DESCRIPTION, JOB ID, START TIME, END TIME, SCHEDULE TIME, FAILURE REASON, SP NAME, COPY NAME, CLIENT NAME, AGENT TYPE NAME, INSTANCE NAME, BACKUPSET NAME, SUBCLIENT NAME, LEVEL, PROTECTED COUNT, FAILED COUNT, RECOVERED COUNT, SKIPPED COUNT, PROTECTED OBJECTS, FAILED OBJECTS, RECOVERED OBJECTS, SKIPPED OBJECTS, MEDIA LABEL, LIBRARY NAME, EXPORT LOCATION, MEDIA LIST, MEDIA LIST, MEDIA SUCCEEDED, MEDIA FAILED, COMMENT, COMMENT, COMMENT, FREE SPACE, FREE SPACE, FREE SPACE, FORCE DECONFIG Y/N, MEDIAAGENT NAME, SCHEDULE/SCHEDULE POLICY NAME, SPAREPOOL/MOUNTPATH NAME, MEDIA SPACE LEFT, THRESHOLD, OTHER LIBRARY, DRIVEPOOL NAME, DRIVE NAME, INITIATER, SOURCE LOCATION, TRANSIT LOCATION, SP LIST, DESTINATION LOCATION, DISK SPACE LOW Y/N, DISK SPACE LOW Y/N, DISK SPACE LOW Y/N, PROPERTY MODIFIED Y/N, MOUNTPATH NAME, SUCCESSFUL CLIENT LIST, FAILED CLIENT LIST, UNKNOWN CLIENT LIST, UP-TO-DATE CLIENT LIST, ALL CLIENT LIST, MEDIA REQUIRE LIST, MEDIA LOCATION LIST, CONDITION CLEARED Y/N, USER NAME, AGENT TYPE ID, RESOURCE WAIT TIME, MESSAGE COUNT, MAILBOX NAME, ELAPSED TIME, CONTENTS, CONTENTS DOWNLOADED, FILES DOWNLOADED, DOWNLOAD SIZE (MB), CLIENT STATUS LIST, JOBS RUNNING CLIENT LIST, LOW CACHE CLIENT LIST, UNREACHABLE CLIENT LIST, SERVER RELEASE, CLIENT RELEASE LIST, DISK SPACE INFO, DISK SPACE INFO, DISK SPACE INFO, LAST ACTIVITY TIME, MORE MEDIA Y/N, SNAPSHOT VOLUME UNIT, WORKFLOW, FLR_SRC_PATH, FLR_DEST_PATH, DEST CLIENT, REPSET NAME, OPERATION TYPE, CS UPGR TIME, CS UPGR TIME, XFER BYTES, XFER SECS, XFER GB PER HOUR, ERR CODE, RECALL REASON, RECALL EXPIRE TIME, RECALL DESTINATION, Report ID, Report Hist ID, Report URL, Report URL, CURRENT BACKUP SIZE, PREVIOUS BACKUP SIZE, PREVIOUS JOBID, PERCENTAGE CHANGE, PRUNED MEDIA BARCODE LIST, PRUNED JOBS COUNT, RESTORE USER NAME, NUMBER OF ITEMS, SIZE, FAILED ATTEMPTS COUNT, GUI Client Name, USER NAME LIST, FAILED ATTEMPT TIME LIST, STORAGE POLICIES USED, SIZE OF DATA TOBE COPIED, MEDIA TOBE COPIED COUNT, JOBS TOBE COPIED, OLDEST JOB ENDDATE, COPIED MEDIA LIST, COPIED DATA SIZE, REPORT NAME, AUTOMATED_CONTENT_CLASSIFICATION_POLICY_NAME, PHASES_IN_JOB, STATUS OF SEARCH PHASE, STATUS OF TAGGING PHASE, STATUS OF ERM CONNECTOR PHASE, STATUS OF RESTORE TO REVIEW SET PHASE, STATUS OF LEGAL HOLD BACKUP PHASE, STATUS OF LEGAL HOLD RESTORE PHASE, SEARCH PHASE SELETED Y/N, TAGGING PHASE SELECTED Y/N, ERM CONNECTOR PHASE SELECTED Y/N, RESTORE TO REVIEW SET PHASE SELECTED Y/N, LEGAL HOLD BACKUP PHASE SELECTED Y/N, LEGAL HOLD RESTORE PHASE SELECTED Y/N, NO. OF ITEMS SELECTED FOR TAGGING, NO. OF ITEMS TAGGED SUCCESSFULLY, NO. OF ITEMS FAILED TO TAG, NO. OF ITEMS SELECTED FOR ERM CONNECTOR, NO. OF ITEMS SUCCEEDED IN ERM CONNECTOR PHASE, NO. OF ITEMS FAILED IN ERM CONNECTOR PHASE, NO. OF ITEMS SELECTED TO RESTORE TO REVIEW SET, NO. OF ITEMS SUCCEEDED IN RESTORE TO REVIEW SET PHASE, NO. OF ITEMS FAILED IN RESTORE TO REVIEW SET PHASE, NO. OF ITEMS SELECTED FOR LEGAL HOLD BACKUP, NO. OF ITEMS SUCCEEDED IN LEGAL HOLD BACKUP PHASE, NO. OF ITEMS FAILED IN LEGAL HOLD BACKUP PHASE, NO. OF ITEMS SELECTED FOR LEGAL HOLD RESTORE, NO. OF ITEMS SUCCEEDED IN LEGAL HOLD RESTORE PHASE, NO. OF ITEMS FAILED IN LEGAL HOLD RESTORE PHASE, NO. OF ITEMS SELECTED TO SEARCH, NO. OF ITEMS SEARCHED SUCCESSFULLY, NO. OF ITEMS FAILED TO SEARCH, Virtual Machine NAME, XFER SIZE, EXTENDED RET. CANDIDATE Y/N, RETAIN UNTIL, LICENSE EXPIRED, NO. OF DAYS LEFT FOR LICENSE EXPIRY, XFER TIME, Task ID, OBJ STORE CACHE, CSV Output File, FileList, LICENSE PERCENT CONSUMED, TIME OF LAST SUCCESSFUL JOB, DATE OF LAST SUCCESSFUL JOB, NO SUCCESSFUL JOB SINCE, TOTAL OBJECTS, DDB NAME, OFFLINE SINCE, FAILED JOB INFO, TOTAL JOBS, PENDING JOBS COUNT, TOP PENDING ERRORS LIST, TOP WAITING ERRORS LIST, SUCCESSFUL MESSAGE, STATUS MESSAGE, ERR CODE MESSAGE, FAILURE REASON MESSAGE, CHECK LOGS MESSAGE, MONITORING POLICY NAME, MONITORING CRITERIA STRING, MATCHED LINE, MATCHED LINE, MATCHED LINE NUMBER, EVENT SEVERITY, EVENT DATE, EVENT PROGRAM, MATCHED LOG FILE, LINES ABOVE MATCHED LINE, LINES BELOW MATCHED LINE, EVENT ID, PARTIALLY SUCCESSFUL CLIENT LIST, CLIENT GROUP NAME, TASK CATEGORY, COMPUTER, VCENTER, ESX, DATASTORE, VMHOSTNAME, IPADDRESS, CLONECLIENTNAME, CLONEHOSTNAME, COPY HOURS, NUMBER OF SUBCLIENTS, SUBSTORE LOCATION, ALERT REASON, INDEX 0, INDEX 1, INDEX 2, INDEX 3, INDEX 4, INDEX 5, INDEX 6, INDEX 7, INDEX 8, INDEX 9, INDEX 10, INDEX 11, INDEX 12, INDEX 13, INDEX 14, INDEX 15, INDEX 16, INDEX 17, INDEX 18, INDEX 19, INDEX 20, INDEX 21, INDEX 22, INDEX 23, INDEX 24, INDEX 25, INDEX 26, INDEX 27, INDEX 28, INDEX 29, INDEX 30, INDEX 31, INDEX 32, INDEX 33, INDEX 34, INDEX 35, INDEX 36, INDEX 37, INDEX 38, INDEX 39, INDEX 40, INDEX 41, INDEX 42, INDEX 43, INDEX 44, INDEX 45, INDEX 46, INDEX 47, INDEX 48, INDEX 49, INDEX 50, INDEX 51, INDEX 52, INDEX 53, INDEX 54, INDEX 55, INDEX 56, INDEX 57, INDEX 58, INDEX 59, INDEX 60, INDEX 61, INDEX 62, INDEX 63, INDEX 64, INDEX 65, INDEX 66, INDEX 67, INDEX 68, INDEX 69, INDEX 70, INDEX 71, INDEX 72, INDEX 73, INDEX 74, INDEX 75, INDEX 76, INDEX 77, INDEX 78, INDEX 79, INDEX 80, INDEX 81, INDEX 82, INDEX 83, INDEX 84, INDEX 85, INDEX 86, INDEX 87, INDEX 88, INDEX 89, INDEX 90, INDEX 91, INDEX 92, INDEX 93, INDEX 94, INDEX 95, INDEX 96, INDEX 97, INDEX 98, INDEX 99, INDEX 100, QUERY NAME, SIZE OF DATA TOBE CONTENT INDEXED, JOBS TOBE CONTENT INDEXED, REPORT DISPLAY NAME, REPORT PARAM NAME, REPORT NAME, REPORT CRITERIA, VM FAILURE REASON, VM STATUS, VIRTUAL MACHINE NAME, VIRTUAL MACHINE HOST NAME, TABLE DATA, INPUT DATA, SEARCH QUERY STRING, SEARCH CRITERIA, SEARCH URL INFO, SEARCH CRITERA MATCHED LINES, JOB OPERATION, PENDING CLIENT LIST, WARNING, LEGAL HOLD NAME, REPORT URL, REPORT MANAGE URL, ADDITIONAL VM INFO, TABLE DATA XML, AUDIT INFO, TOTAL METRICS RESULT COUNT, CLIENT HOST NAME, ALARM HEADER, JOB DESCRIPTION, OBJECT SIZE, QUOTA LIMIT, SPACE CONSUMED, USER ID, OPERATION PERFORMED BY USER, USER GROUP NAME, CLEANUP DATA TEXT, CLIENT_OS_NAME, CLIENT_OS_PLATFORM, CLIENT_OS_SUBTYPE, CLIENT_OS_TYPE, CLIENT_OS_VERSION, OPERATION DATA, OFFLINE REASON, DESTINATION CLIENT, SOURCE CLIENT, CLIENT DESCRIPTION, DATA WRITTEN, PERCENTAGE INCREASE IN OBJECT COUNT, PREVIOUS JOB OBJECT COUNT, SHARE ENTITY INFO, ACTIVITY ID, ACTIVITY NAME, DIGEST INFO, ENTITY GUID, IS FILE ACTIVITY, FILE NAME, OLD FILE NAME, OPERATION DATA BODY, SHARE NAME, SHARE ID, MAIL ID, SEVERITY, SEVERITY INT, CLIENT GROUP LIST, ORGANIZATION NAME, FAILOVER COMMSERVE, FAILOVER INITIATED FROM, DIRECTORY WITH LOW SPACE, THRESHOLD FOR LOW SPACE, EXCLUDED FROM SLA, FAILED MAILBOXES, SKIPPED MAILBOXES, SUCCESSFUL MAILBOXES, FAILED JOBS THRESHOLD, PENDING JOBS THRESHOLD, FAILED JOBS COUNT, SUBCLIENT DESCRIPTION, SUCCEEDED JOBS THRESHOLD, SUCCEEDED JOBS COUNT, DESCRIPTION HTML, TIME EPOCH, VERSION GUID, CLIENT DISPLAY NAME, NEED REBOOT CLIENT LIST, ALERT TIME, VIRTUAL MACHINE INSTANCE UUID, CLIENT VERSION, JOB STARTED FROM, USER LOGIN NAME, TEXT DATA, QUERY GENERATED HTML CONTENT, FAILED VMS, PARTIALSUCCESS VMS, FAILOVER GROUP, FAILOVER STATUS, DATE OF LAST REPLICATION JOB, TIME OF LAST REPLICATION JOB, REPLICATION GROUP, REPLICATION STATUS, Synchronization Status, EVENT CODE, TIME ZONE, UTC_TIMESTAMP, ALERT LINK, CUSTOMER ID, VIRTUAL MACHINE CLIENT NAME, DOWNLOAD JOB MESSAGE, ALERT EVENT ID, WORKLOAD]
Name of the token.
value string
Value to be compared for the token
ruleSecValue string
Secondary value used for BETWEEN and NOT_BETWEEN matchCondition.
matchCondition string
Possible values: [EQUALS, DOES_NOT_EQUALS, CONTAINS, DOES_NOT_CONTAINS, LESSTHAN, LESSTHAN_EQUAL, GREATERTHAN, GREATERTHAN_EQUAL, BETWEEN, ANY_IN_SELECTION, FROM, TILL, NOT_BETWEEN]
timeRange object
Time range is for time related token rule values to specify from and to time in unix timestamp format.
fromTime string
From time value in unix timestamp format
toTime string
To time value in unix timestamp format
dateRange object
Date range is for date related token rule values to specify from and to date in unix date timestamp format..
fromDate string
From date value in unix timestamp format
toDate string
To date value in unix timestamp format
timeRange object[]
Time range selection details
fromTime string
From time value in unix timestamp format
toTime string
To time value in unix timestamp format
tokenFormat string
Possible values: [NONE, REGULAR_EXPRESSION, CASE_SENSITIVE, MATCH_WHOLE_WORD, INCLUSIVE]

{
  "id": 0,
  "name": "string",
  "alertSummary": {
    "type": {
      "id": 0,
      "name": "Clients"
    },
    "category": {
      "id": 0,
      "name": "Configuration"
    },
    "criteria": {
      "id": 0,
      "name": "Backup Job Failed",
      "paramsList": [
        {
          "unit": 0,
          "type": 0,
          "value": 0,
          "paramIndex": 0
        }
      ]
    }
  },
  "sendIndividualNotifications": true,
  "processDiscoveredVMs": true,
  "subscriptionBasedAlert": true,
  "associations": [
    {
      "id": 0,
      "name": "string",
      "type": "ALL_SERVERS",
      "parentEntity1": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      },
      "parentEntity2": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      },
      "parentEntity3": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      },
      "parentEntity4": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      }
    }
  ],
  "alertTarget": {
    "sendAlertTo": [
      "LIVEFEEDS"
    ],
    "recipientsOperationType": "ADD",
    "recipients": {
      "to": [
        {
          "id": 0,
          "name": "string",
          "type": "USER"
        }
      ],
      "cc": [
        {
          "id": 0,
          "name": "string",
          "type": "USER"
        }
      ],
      "bcc": [
        {
          "id": 0,
          "name": "string",
          "type": "USER"
        }
      ],
      "webHookId": 0
    }
  },
  "templates": {
    "locale": {
      "id": 0,
      "name": "string"
    },
    "email": "string",
    "console": "string",
    "eventViewer": "string",
    "webhook": "string"
  },
  "additionalProperties": {
    "status": 0
  },
  "tokens": {
    "match": "AND",
    "ruleGroups": [
      {
        "match": "AND",
        "rules": [
          {
            "tokenName": "SUBJECT END",
            "value": "string",
            "ruleSecValue": "string",
            "matchCondition": "EQUALS",
            "timeRange": {
              "fromTime": "string",
              "toTime": "string"
            },
            "dateRange": {
              "fromDate": "string",
              "toDate": "string",
              "timeRange": [
                {
                  "fromTime": "string",
                  "toTime": "string"
                }
              ]
            },
            "tokenFormat": "NONE"
          }
        ]
      }
    ]
  }
}

Get Alert DefinitionsDetails​

Get Alert DefinitionsDetails