Skip to navigation
API ReferenceObservabilityErrors

Acknowledge an incident

Acknowledges an incident or clears the acknowledgement, and sets its notes. Send either field or both.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Path parameters

incident_idstringRequired
Incident ID, from List incidents.

Request

This endpoint expects an object.
is_acknowledgedbooleanOptional

true to acknowledge, false to clear it.

notesstringOptional<=4000 characters
Replaces the incident's notes. Everyone in the organization can read them.

Response

The updated incident.
idstring
Incident ID.
titlestring
Main error class and environment, in words.
environmentstring
fault_domainenum

Whose fault the failure is, derived from error_class: user (your requests or your own provider keys), provider (the upstream provider), respan (Respan's gateway or managed capacity), or none (client cancellations).

Allowed values:
started_atdatetime
ended_atdatetime or null

End of the last elevated minute, or null while ongoing.

duration_secondsinteger

From started_at to data_through_at.

data_through_atdatetime

How far the evidence goes: ended_at once past; for an ongoing incident, the latest minute that is fully ingested.

stateenum
Allowed values:
resolution_reasonenum or null

Why it ended: the rate recovered, requests stopped, or the scope went silent. null while ongoing.

Allowed values:
severityenum
Allowed values:
triggerenum

spike for a sudden jump, drift for a sustained smaller rise.

Allowed values:
peak_error_ratedouble
A fraction from 0 to 1.
baseline_error_ratedouble
A fraction from 0 to 1.
error_countinteger
request_countinteger
hot_bucket_countinteger
Minutes that tripped the detector.
error_class_breakdownmap from strings to integers
Failed requests per error class.
dominant_error_classstring
Most common error class.
dominant_fingerprintstring or null

Error group with the most failures. Usually null in List incidents; Get an incident fills it.

impactobject
primary_errorobject
acknowledged_atdatetime or null
is_acknowledgedboolean
notesstring
Team notes. Visible to everyone in the organization.
created_atdatetime
updated_atdatetime
When the detector last evaluated the incident. Acknowledging or editing notes doesn't change it.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error