v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Alerts

Clear alerts

This API endpoint clears the specified alerts. Clearing an alert marks it as resolved with an optional reason and notes.

post/network-notifications/v1/alerts/clear

Request body

keysstring[] required

List of alert keys to clear.

reason'Problem was resolved' | 'False Positive' | 'Insufficient information for troubleshooting' | 'Alert is not important' | 'Other'

The reason for clearing the alerts.

notesstring

Additional notes about clearing the alerts.

Example request

{
  "keys": [
    "22071893000:47765082406",
    "22071893000:47764775046"
  ],
  "reason": "Problem was resolved",
  "notes": "Firmware updated to version 10.4.0"
}

Response

Accepted response for asynchronous alert action operations.

responsestring

Response message indicating the action was accepted.

taskIdstring

Unique task identifier for tracking the asynchronous operation.

locationstring

URL to check the status of the asynchronous operation.

Example response

{
  "response": "Request accepted",
  "taskId": "abc123-def456-ghi789",
  "location": "/network-notifications/v1/alerts/async-operations/abc123-def456-ghi789"
}