You can delete one or more alert definitions and all of the associated information.
Request line
POST baseURL/alertapi.do?action=deleteAlertDef
The request payload is a JSON object.
Request body
{
"alertId":[
,
]
}
Request example
POST /alertapi.do?action=deleteAlertDef
{
"alertId":[
23423, 542324
]
}
Request parameters
| Parameter | Type | Description |
|---|---|---|
| alertId | Integer[ ] | List of alert definition IDs, to be deleted. |
Response body
{
"deleted":{
"alertId":[
]
}
}
{
"failed":[
{
"alertId":,
"error":"",
"code":""
}
]
}
Response examples
Success
{
"deleted":{
"alertId":[
23423
]
}
}
Error
{
"failed":[
{
"alertId":23423,
"error":"Alert definition with id:[3] not found.",
"code":"A4040010"
}
]
}
For a list of alert API error codes, see Alert API response error codes and messages.