Edit Alert Definitions
Select
SaaS
Customer Managed
Edit Alert Definition details
Path Parameters
- id int32 required
- application/json
Request Body
- newName string
The new name of the alert definition
criteriaList object[]
- sendIndividualNotifications boolean
Flag indicating the functionality to send individual notifications
- subscriptionBasedAlert boolean
Flag to indicate whether its a subscription based alert.
- processDiscoveredVMs boolean
Flag indicating the functionality to send individual notifications for each discovered virtual machine
- associationsOperationType string
Possible values: [
ADD
,DELETE
,OVERWRITE
]Default value:
ADD
Allows adding to, overwriting and deleting existing alert associations. default is adding to existing alert associations
associations object[]
alertTarget object
templates object
tokens object
eventCriteriaDetails object
globalConfigInfo object
Responses
- 200
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Internal Server Error
PUT /v4/alertdefinitions/:id
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"criteriaList": [
{
"id": 0,
"name": "Backup Job Failed",
"paramsList": [
{
"unit": 0,
"type": 0,
"value": 0,
"paramIndex": 0
}
],
"notificationCriteria": {
"value": 1,
"delayTime": 0,
"persistTime": 0
}
}
],
"sendIndividualNotifications": true,
"subscriptionBasedAlert": true,
"processDiscoveredVMs": true,
"associationsOperationType": "ADD",
"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"
},
"flags": {
"exclude": true
}
}
],
"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",
"workflow": {
"id": 0,
"name": "string",
"clientId": 0,
"clientName": "string"
},
"workflowInputDetails": "string"
},
"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"
}
]
}
]
},
"eventCriteriaDetails": {
"opBetweenConditions": 0,
"criteriaName": "string",
"conditions": [
{
"name": "string",
"id": 0,
"operation": "EQUALS",
"value": "string",
"fromValue": "string",
"toValue": "string",
"advancedCriteria": [
"NONE"
],
"valuesList": [
0
]
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}'