API Guide

POST /alerts/{id}/ack
Updates the state of an alert to the ACK state.
API
POST /alerts/{id}/ack
Description This API updates the state of an alert from OPEN to ACK state.
Parameters
Table 3. API parameters
Filter name Description
*id
required string (path)
The alert ID to acknowledge.
Responses 200 — Success or error response
{
"new_object_id": null,
"id": "ack_alert_success",
"message": "Alert has been acknowledged successfully.",
"messageParams": [],
"messages": [
{
"id": "ack_alert_success",
"message": "Alert has been acknowledged successfully.",
"field_name": null,
"messageParams": []
}
]
}
401 — You are not authorized to perform this operation
{
"new_object_id": null,
"id": "ack_alert_success",
"message": "Alert has been acknowledged successfully.",
"messageParams": [],
"messages": [
{
"id": "ack_alert_success",
"message": "Alert has been acknowledged successfully.",
"field_name": null,
"messageParams": []
}
]
}
404 — Requested entity does not exist
{
"new_object_id": null,
"id": "ack_alert_success",
"message": "Alert has been acknowledged successfully.",
"messageParams": [],
"messages": [
{
"id": "ack_alert_success",
"message": "Alert has been acknowledged successfully.",
"field_name": null,
"messageParams": []
}
]
}
Alerts
13