Skip to main content

Create Alert Definitions​

Create Alert Definitions

Request Body
  • name string
  • alertType object
  • category string

    Possible values: [DATA_AGING, AUX_COPY, DATA_PROT, DATA_RECOV, EXP_RECOV, DATA_VERIFI, MEDIA_INVENT, SCH_EXPORT, MEDIA_ERASE, CLIENTS, AGENTS, COMMCELL, MEDIA_AGENTS, SCHE, STOR_POL, LIBRARY, LIB_MAN, VAULT_TRAK, FTP_DOWNLOAD, CLIENT_DIST, DEVICE_STATUS, ERASE_DATA, APP_EXCHANGE, DOWNLOAD_AVAIL, APP_FLR, UPGR_UPDATES, DATA_CLASSIFI, FLR_JOB, OFFLINE_CONT_INDEX, APP_SHAREPOINT, SRM_WINFS, SRM_ORACLE, SRM_SQL, SRM_NAS, SRM_EXCHANGE, SRM_SHARE_POINT, SRM_UNIXFS, SRM_COST_ANALYSIS, SRM_NETWARE, SRM_ADVISORY, SRM, REPORT, INFO_MANAGEMENT, MEDIA_REFRESHING, DEDUPDBSYNC, SRM_REPORT, LOG_MONITORING, EVENT_MONITORING, CLIENT_GROUPS, LICENSE, BACKUP_COPY, WORKFLOW, LOG_MONITORING_WINDOW_EVENT, VIRTUALIZE_ME, CUSTOM_QUERY, DATA_ANALYTICS, UNINSTALL_SOFTWARE, UPGRADE_CLIENT, INSTALL_SOFTWARE, USERS, USER_GROUPS, EDGE_DRIVE, ADMIN_JOB, COMMSERV_FAILOVER, ADMIN_ALERT, REPLICATION_ALERT]

    Defines the category of the alert

  • criteria 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]

    Defines the criteria of the alert

  • 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
  • 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

Responses

Success

Schema
  • id int32
  • name string
POST /v4/alertdefinitions

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
Body
{

  "name": "string",

  "alertType": {

    "category": "DATA_AGING",

    "criteria": "SUCCEEDED",

    "paramsList": [

      {

        "unit": 0,

        "type": 0,

        "value": 0,

        "paramIndex": 0

      }

    ]

  },

  "sendIndividualNotifications": 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"

  }

}

curl -L -X POST 'https://localhost/webconsole/api/V4/AlertDefinitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "alertType": {
    "category": "DATA_AGING",
    "criteria": "SUCCEEDED",
    "paramsList": [
      {
        "unit": 0,
        "type": 0,
        "value": 0,
        "paramIndex": 0
      }
    ]
  },
  "sendIndividualNotifications": 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"
  }
}'