API Guide

404 — Requested entity does not exist
{
"new_object_id": null,
"id": "unack_alert_success",
"message": "Alert has been un-acknowledged successfully.",
"messageParams": [],
"messages": [
{
"id": "unack_alert_success",
"message": "Alert has been un-acknowledged successfully.",
"field_name": null,
"messageParams": []
}
]
}
default — Success or error response
{
"new_object_id": null,
"id": "unack_alert_success",
"message": "Alert has been un-acknowledged successfully.",
"messageParams": [],
"messages": [
{
"id": "unack_alert_success",
"message": "Alert has been un-acknowledged successfully.",
"field_name": null,
"messageParams": []
}
]
}
POST /alerts/{id}/clear
Clears an alert.
API
POST /alerts/{id}/clear
Description This API clears a specific alert, then deletes it from the active alerts list.
Parameters
Table 5. API parameters
Filter name Description
*id
required string (path)
The alert ID to clear.
Responses 200 — Success or error response
{
"new_object_id": null,
"id": "clear_alert_success",
"message": "Alert has been cleared successfully.",
"messageParams": [],
"messages": [
{
"id": "clear_alert_success",
"message": "Alert has been cleared successfully.",
"field_name": null,
"messageParams": []
}
]
}
Alerts 15