Jump to

• Request
• Response
• Examples

Clear the alert

post

/serviceapi/eventServices/alerts/{alertId}/actions/clear

This operation clears the alert identified by the id.

Request

Supported Media Types

• application/json

Path Parameters

• alertId: string
  The id of the alert

Body ()

The comment can be optionally added to the alert when it is closed manually

Root Schema : ClearAlertAnnotation

Type: object

The comment can be optionally added to the alert when it is closed manually

Show Source

• comment: string
  The comment to be added to the alert while clearing it

  Example: Underlying issue has been fixed for this alert

{
    "type":"object",
    "required":[
        "comment"
    ],
    "properties":{
        "comment":{
            "type":"string",
            "description":"The comment to be added to the alert while clearing it",
            "example":"Underlying issue has been fixed for this alert"
        }
    },
    "description":"<p>\n The comment can be optionally added to the alert when it is closed manually\n</p>"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Alert was cleared

Body ()

Root Schema : ClearedAlertResponse

Type: object

The returned response when an alert is closed manually

Show Source

• canonicalLink: string
  The link to get details of the cleared alert

  Example: /serviceapi/eventServices/alerts/62965132339213727047162539738389170623
• status: string
  Status of the clear alert operation

  Example: OK

{
    "type":"object",
    "required":[
        "status",
        "canonicalLink"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the clear alert operation",
            "example":"OK"
        },
        "canonicalLink":{
            "type":"string",
            "description":"The link to get details of the cleared alert",
            "example":"/serviceapi/eventServices/alerts/62965132339213727047162539738389170623"
        }
    },
    "description":"<p>\n The returned response when an alert is closed manually\n</p>"
}

400 Response

This error is raised if the manual clear action is not allowed on the specific alert or if the alert id is invalid

Body ()

Root Schema : InvalidRequest

Type: object

When invalid alert API request is received, alert system returns this response.

Show Source

• errorCode: string
  The alert system's internal error code
• errorMessage: string
  The alert system's internal error message
• httpMessage: string
  The http error message
• httpStatusCode: string
  Default Value: 400

  The http status code

{
    "type":"object",
    "required":[
        "httpStatusCode",
        "httpMessage",
        "errorCode",
        "errorMessage"
    ],
    "properties":{
        "httpStatusCode":{
            "type":"string",
            "description":"The http status code",
            "default":"400"
        },
        "httpMessage":{
            "type":"string",
            "description":"The http error message"
        },
        "errorCode":{
            "type":"string",
            "description":"The alert system's internal error code"
        },
        "errorMessage":{
            "type":"string",
            "description":"The alert system's internal error message"
        }
    },
    "description":"<p>\n When invalid alert API request is received, alert system returns this response.\n</p>"
}

500 Response

encountered unhandled exception

Body ()

Root Schema : UnhandledException

Type: object

When alert system runs into unhandled exception, it returns this response.

Show Source

• errorCode: string
  Default Value: general_error

  The alert system's error code for unhandled exception
• errorMessage: string
  Default Value: Internal Server Error

  The alert system's error message for unhandled exception
• httpMessage: string
  Default Value: Internal Server Error

  The http error message
• httpStatusCode: string
  Default Value: 500

  The http status code

{
    "type":"object",
    "required":[
        "httpStatusCode",
        "httpMessage",
        "errorCode",
        "errorMessage"
    ],
    "properties":{
        "httpStatusCode":{
            "type":"string",
            "description":"The http status code",
            "default":"500"
        },
        "httpMessage":{
            "type":"string",
            "description":"The http error message",
            "default":"Internal Server Error"
        },
        "errorCode":{
            "type":"string",
            "description":"The alert system's error code for unhandled exception",
            "default":"general_error"
        },
        "errorMessage":{
            "type":"string",
            "description":"The alert system's error message for unhandled exception",
            "default":"Internal Server Error"
        }
    },
    "description":"<p>\n When alert system runs into unhandled exception, it returns this response.\n</p>"
}

Back to Top

Examples

Clear the alert

curl -u ${OMC_USERNAME}:${PASSWORD} -X POST -d '{"comment": "Sample comment while closing an alert manually"}' "https://serverurl/serviceapi/eventServices/alerts/62965132339213727047162539738389170623/actions/clear"

The response might look like the following:

     {
       "status":"OK",
       "canonicalLink":"/serviceapi/eventServices/alerts/62965132339213727047162539738389170623
     }

Back to Top