Skip to main content
POST
Acknowledge (mark as seen) monitoring alerts

Overview

Acknowledge (mark as seen) one or all monitoring alerts for the authenticated customer.

Request

  • Method: POST
  • Path: /monitoring-alerts/acknowledge
  • Body: JSON object specifying either a single alert ID or all alerts

Request Body

  • alert_id (string, optional) - ID of the alert to acknowledge
  • all (boolean, optional) - If true, acknowledges all alerts for the customer
  • Exactly one of alert_id or all must be provided

Example Request (single alert)

Example Request (all alerts)

Success Response

  • Status: 200 OK

Response Body (single alert)

Response Body (all alerts)

Error Handling

  • 400 Bad Request
    • Invalid request body or both alert_id and all provided
    • Example: { "error": "Either alert_id OR all must be provided, but not both" }
  • 404 Not Found
    • Alert with specified ID was not found
    • Example: { "error": "Alert not found" }
  • 401 Unauthorized
    • Missing or invalid customer authentication
  • 500 Internal Server Error
    • Unexpected server error

Notes

  • Only the owner (customer) may acknowledge their alerts
  • Bulk acknowledgment returns the number of alerts updated

Authorizations

X-API-KEY
string
header
required

Body

application/json

Either alert_id OR all must be provided, but not both

alert_id
string
required

ID of the alert to acknowledge

all
boolean

If true, acknowledge all alerts

Response

Success

success
boolean

Whether the operation succeeded

message
string

Success message

unacknowledged_count
integer | null

Number of unacknowledged alerts remaining