POST
/
monitoring-alerts
/
acknowledge
curl --request POST \
  --url https://api.godiligent.ai/monitoring-alerts/acknowledge \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "alertId": "<string>",
  "all": true
}'
{
  "success": true,
  "message": "<string>",
  "updatedCount": 123
}

​
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

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

​
Example Request (single alert)

{
  "alertId": "532ebbd3-269d-4c8f-b73b-2269eb83f1ae"
}

​
Example Request (all alerts)

{
  "all": true
}

​
Success Response

  • Status: 200 OK

​
Response Body (single alert)

{
  "success": true,
  "message": "Alert acknowledged"
}

​
Response Body (all alerts)

{
  "success": true,
  "message": "7 alerts acknowledged",
  "updatedCount": 7
}

​
Error Handling

  • 400 Bad Request
    • Invalid request body or both alertId and all provided
    • Example: { "error": "Either alertId 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 alertId OR all must be provided, but not both

Response

200
application/json

Success

The response is of type object.