Get Alert Type and Alert Custom Rules list

Select

SaaS

Customer Managed

Get the list of alert types and alert custom rules

Responses

Success

application/json

Schema
Example (from schema)

Schema

alertTypes object[]
category object
category utilized in alert definition creation
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
value string
Possible values: [DATA_AGING, AUX_COPY, DATA_PROT, DATA_RECOV, DATA_VERIFI, CLIENTS, MEDIA_AGENTS, LIB_MAN, DEVICE_STATUS, DATA_CLASSIFI, DEDUPDBSYNC, EVENT_MONITORING, LICENSE, CUSTOM_QUERY, USERS, EDGE_DRIVE, COMMSERV_FAILOVER, ADMIN_ALERT, REPLICATION_ALERT]
categoryType 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
criteria utilized in alert definition creation
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, Event Viewer Events]
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
notificationCriteria object
value int32
Default value: 1
Bit flag indicating notification criteria value. 1 means immediate, 2 means repeated and 8 means delayed
delayTime int32
Delayed time in seconds when the notification criteria value contains delayed flag
persistTime int32
Persisting time in seconds when the notification criteria value contains repeated flag
value string
Possible values: [SUCCEEDED, FAILURE_ATTEMTS, FAILED, SKIPPED, DELAYED, MEDIA_REQUIRED, INITIATED, ROLLED_BACK, MEDIA_NEEDS_IMPORT, MEDIA_HANDLING_REQUIRED, MEDIA_PICKED_UP, MEDIA_REACHED_DESTINATION, MEDIA_RET_SOURCE, JOB_ACTIVITY, ASR_BACKUP_OCCURED, PROPERTIES_MODIFIED, ALERT_MODIFIED, DISK_SPACE_LOW, FORCED_DECONF, LIBRARY_OFFLINE, SCHEDULER_CHANGES, INSUFF_STORAGE, TAPE_HANDLING_ERR, TAPE_HANDLING_REQ, TAPE_MOUNT_ERR, MAINT_REQ, MAINT_OCCURED, USE_OVERWRITE_MEDIA, DRIVE_OFFLINE, MEDIAAGENT_OFFLINE, MOUNTPATH_OFFLINE, NW_FAILURE_ATTEMTS, JOURNAL_MAILBOX, JR_DISK_SPACE_LOW, IC_DISK_SPACE_LOW, UPDATE_REQUIRED, DOWNLOAD_REQUIRED, UPDATES_AVAILABLE, RELEASE_UPGRADE_REQUIRED, UPDATES_REQUIRED, MEDIA_READY_IN_CAP, FLR_LOG_FILE_HIGH, FLR_FREE_SPACE_LOG_FILE_VOL_LOW, FLR_NO_PLAY_ACTIVITY, FLR_NO_TRANSFER_ACTIVITY, NO_DATA_PROTECTION, CLASSIFICATION_FAILED, FLR_FAILED_REPLICATION, SHAREPOINT_VIRTUAL_SERVERS, SHAREPOINT_V3_UPGRADE, LIBR_MEDIA_RECALLED, BACKUP_SIZE_ANOMALY_INCR, BACKUP_SIZE_ANOMALY_DECR, JOB_STARTED, LOGIN_FAILED, AUXCOPY_FALLEN_BEHIND, SUCCESS_WITH_ERRORS, LICENSE_EXPIRY, CCP_MODIFIED, LICENSE_CONSUMED, LOG_MONITORING, EVENT_MONITORING, LIBR_NONENCRYPTED_MEDIA_EXPORT, CICOPY_FALLEN_BEHIND, CLIENT_JOB_NOT_RUN, CLIENT_CERTIFICATE_EXPIRY, JOB_EXCEEDED_RUNNINGTIME, FILES_FAILED_COUNT, FILES_FAILED_PERCENT, DDB_CORRUPTED, SUCCESSIVE_FAILED, DDB_DISK_SPACE_LOW, JOBS_PENDING_STATE, BACKUP_SIZE, GENERIC_QUERY, JOB_COMMITTED, JOB_RESULTS_DISK_SPACE_LOW, INDEX_CACHE_DISK_SPACE_LOW, GALAXY_DIR_DISK_SPACE_LOW, QUOTA_EXCEEDED, QUOTA_THREASHOLD, QUOTA_VALIDATION_FAILED, EDGE_DRIVE_ACTION, NT_DDB_OFFLINE, NT_OBJECT_COUNT_INCR_PERCENT, NT_FAILOVER_STARTED, NT_FAILOVER_ACTIVITY, NT_FAILOVER_COMPLETE, NT_FAILOVER_FAILED, NT_FAILOVER_CS_UNREACHABLE, NT_FAILOVER_CS_NOT_RUNNING, NT_FAILOVER_PASSIVE_NODE_UNREACHABLE, NT_ADMIN_ALERT_EVENT_ANOMALOUS, NT_ADMIN_ALERT_JOB_RUNTIME_ANOMALOUS, NT_ANOMALOUS_PENDING_JOBS, NT_ANOMALOUS_FAILED_JOBS, NT_ALL_CRITERIA, NT_FILE_SYSTEM_QUOTA_EXCEEDED, NT_FILE_SYSTEM_QUOTA_THRESHOLD, NT_FILE_SYSTEM_QUOTA_VALIDATION_FAILED, NT_ADMIN_ALERT_JOB_ACTIVITY_ANOMALOUS, NT_ANOMALOUS_SUCCEEDED_JOBS, NT_CLIENT_OFFLINE, NT_ADMIN_ALERT_DDB_PRUNING_ANOMALOUS, NT_ADMIN_ALERT_SMART_STATE_MA, NT_JOB_SUCCEEDED_WITH_WARNINGS, NT_ADMIN_ALERT_PREDICT_SLA_FALL, NT_ADMIN_ALERT_SALESFORCE_OBJECT_BACKUP_ANOMALOUS, NT_REPLICATION_JOB_NOT_RUN, NT_DELAYED_REPLICATION, NT_REPLICATION_STATUS_IN_SYNC, NT_REPLICATION_STATUS_SYNC_PENDING, NT_REPLICATION_STATUS_SYNC_PAUSED, NT_REPLICATION_STATUS_SYNC_FAILED, NT_FAILOVER_STATUS_FAILOVER_FAILED, NT_FAILOVER_STATUS_FAILOVER_COMPLETE, NT_FAILOVER_STATUS_FAILBACK_FAILED, NT_FAILOVER_STATUS_REVERT_FAILOVER_FAILED]
queryDetail object
id int32
name string
actionsAllowed int32
bit flag indicating actions allowed on this alert type. 128 means subscription support is present.
processDiscoveredVMs boolean
Default value: false
whether process discovered virtual machines enabled or not
notificationOptionsAllowed int32
Bit flag indicating notification criteria value. 1 means immediate, 2 means repeated and 8 means delayed

{
  "alertTypes": [
    {
      "category": {
        "id": 0,
        "name": "Clients",
        "value": "DATA_AGING"
      },
      "categoryType": {
        "id": 0,
        "name": "Configuration"
      },
      "criteria": {
        "id": 0,
        "name": "Backup Job Failed",
        "paramsList": [
          {
            "unit": 0,
            "type": 0,
            "value": 0,
            "paramIndex": 0
          }
        ],
        "notificationCriteria": {
          "value": 1,
          "delayTime": 0,
          "persistTime": 0
        },
        "value": "SUCCEEDED"
      },
      "queryDetail": {
        "id": 0,
        "name": "string"
      },
      "actionsAllowed": 0,
      "processDiscoveredVMs": false,
      "notificationOptionsAllowed": 0
    }
  ]
}

Get Alert Type and Alert Custom Rules list​

Get Alert Type and Alert Custom Rules list