Pausing an alert definition evaluation

Ops Center Analyzer Detail View REST API Reference Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99ANA004-11

You can pause the alert definition to stop the evaluation and notification.

Request line

POST baseURL/alertapi.do?action=disableAlertDef

The request payload is a JSON object.

Request parameters

Parameter Type Description
alertId Integer[ ] List of alert definition IDs to be paused.

Request example

POST /alertapi.do?action=disableAlertDef
{
  "alertId":[
    23423, 542324
  ]
}

Response body

{
  "disabled":{
    "alertId":[
      
    ]
  }
}
{
  "failed":[
    {
      "alertId":,
      "error":"",
      "code":""
    }
  ]
}

Response examples

Success

{
  "disabled":{
    "alertId":[
      23423
    ]
  }
}

Error

{
  "failed":[
    {
      "alertId":12,
      "error":"Alert definition with id:[12] not found.",
      "code":"A8040010"
    }
  ]
}

For a list of alert API error codes, see Alert API response error codes and messages.