Trash alert

curl --request DELETE \
  --url https://api.withorb.com/v1/alerts/{alert_configuration_id} \
  --header 'Authorization: Bearer <token>'

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

Alert

Trash alert

This endpoint trashes a subscription- or customer-scoped alert. The alert is soft-deleted: it stops firing immediately and no longer appears in fetch or list responses, while the underlying record is retained internally for audit.

Plan-level alerts cannot be trashed via the API — disable them instead (POST /v1/alerts/{alert_configuration_id}/disable). Their removal would need to be unwound from every subscription the alert was propagated to, which isn’t supported yet.

DELETE

alerts

{alert_configuration_id}

Trash alert

curl --request DELETE \
  --url https://api.withorb.com/v1/alerts/{alert_configuration_id} \
  --header 'Authorization: Bearer <token>'

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

alert_configuration_id

string

required

Response

No Content

Update alert

Disable alert by ID

⌘I