incidents.delete

Permanently delete an incident created through the Incidents API and its associated incident data.

Facts


Method	`POST https://yourinstance.getdx.net/api/incidents.delete`

Arguments

Required arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.
`reference_id`	`Text` or `Integer`	Unique identifier of the API-created incident to delete. Example: `36b1f37a-e60f-4ccd-b0c4-878a6d1175fe`

Usage info

Deletion is permanent. It removes the incident along with its metadata, service associations, and catalog entity links. Shared catalog entities and services are not deleted.

Only incidents created through incidents.upsert can be deleted through this method. Incidents managed by native connectors are not affected, even when a connector incident has the same reference_id.

This method is idempotent. If an API-created incident is deleted, action is deleted. If the reference_id does not identify an API-created incident or the incident was already deleted, the request still succeeds and action is not_found. This makes retries safe after a timeout or lost response.

Example request

curl -X POST https://yourinstance.getdx.net/api/incidents.delete \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx" \
  --data '{
    "reference_id": "36b1f37a-e60f-4ccd-b0c4-878a6d1175fe"
  }'

Deleted response

{
  "ok": true,
  "action": "deleted",
  "reference_id": "36b1f37a-e60f-4ccd-b0c4-878a6d1175fe"
}

Not found response

{
  "ok": true,
  "action": "not_found",
  "reference_id": "36b1f37a-e60f-4ccd-b0c4-878a6d1175fe"
}

Errors

Error	Description
`not_authed`	The request did not include a valid API key.
`required_params_missing`	`reference_id` was not provided.
`invalid_reference_id`	`reference_id` is not text or an integer.