> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://respan.ai/docs/apis/errors/acknowledge-incident/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://respan.ai/_mcp/server. # Acknowledge an incident POST https://api.respan.ai/api/pulses/incidents/{incident_id}/acknowledgement/ Content-Type: application/json Acknowledges an incident or clears the acknowledgement, and sets its notes. Send either field or both. Reference: https://respan.ai/docs/apis/errors/acknowledge-incident ## Authentication - `Authorization` header (bearer token, required) — Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer \. 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. ## Request ### Path parameters - `incident_id` (string, required) — Incident ID, from List incidents. ### Body (application/json) This endpoint expects an ErrorIncidentAcknowledgementRequest. - `is_acknowledged` (boolean, optional) — `true` to acknowledge, `false` to clear it. - `notes` (string, optional) — Replaces the incident's notes. Everyone in the organization can read them. ## Response ### 200 The updated incident. - `id` (string, required) — Incident ID. - `title` (string, required) — Main error class and environment, in words. - `environment` (string, required) - `fault_domain` (enum, required) — 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: `user`, `respan`, `provider`, `none` - `started_at` (datetime, required) - `ended_at` (datetime, required, nullable) — End of the last elevated minute, or `null` while ongoing. - `duration_seconds` (integer, required) — From `started_at` to `data_through_at`. - `data_through_at` (datetime, required) — How far the evidence goes: `ended_at` once past; for an ongoing incident, the latest minute that is fully ingested. - `state` (enum, required) - Allowed values: `ongoing`, `past` - `resolution_reason` (enum, required, nullable) — Why it ended: the rate recovered, requests stopped, or the scope went silent. `null` while ongoing. - Allowed values: `recovered`, `no_traffic`, `stale` - `severity` (enum, required) - Allowed values: `low`, `medium`, `high`, `critical` - `trigger` (enum, required) — `spike` for a sudden jump, `drift` for a sustained smaller rise. - Allowed values: `spike`, `drift` - `peak_error_rate` (double, required) — A fraction from 0 to 1. - `baseline_error_rate` (double, required) — A fraction from 0 to 1. - `error_count` (integer, required) - `request_count` (integer, required) - `hot_bucket_count` (integer, required) — Minutes that tripped the detector. - `error_class_breakdown` (map from string to integer, required) — Failed requests per error class. - `dominant_error_class` (string, required) — Most common error class. - `dominant_fingerprint` (string, required, nullable) — Error group with the most failures. Usually `null` in List incidents; Get an incident fills it. - `impact` (ErrorIncidentImpact, required) - `primary_error` (ErrorIncidentPrimaryError, required) - `acknowledged_at` (datetime, required, nullable) - `is_acknowledged` (boolean, required) - `notes` (string, required) — Team notes. Visible to everyone in the organization. - `created_at` (datetime, required) - `updated_at` (datetime, required) — When the detector last evaluated the incident. Acknowledging or editing notes doesn't change it. ## Errors ### 400 Bad Request Error The body has neither field, or a field is invalid. - `map from string to list of string` ### 403 Forbidden Error Forbidden: the API key is missing, invalid or expired; the key doesn't grant `logs:update` (Write access does). - `detail` (string, required) ### 404 Not Found Error No incident with this ID in your organization. - `error` (string, required) ### 429 Too Many Requests Error Rate limited. This endpoint allows 60 requests per minute per organization. - `detail` (string, required) ## Types ### ErrorIncidentImpact - `error_count` (integer, required) — Failed requests in the incident window. - `request_count` (integer, required) — All requests in the incident's environment over the window. - `error_rate` (double, required) — `error_count` / `request_count`. A fraction from 0 to 1. - `peak_error_rate` (double, required) — Highest one-minute error rate. A fraction from 0 to 1. - `baseline_error_rate` (double, required) — The scope's usual error rate when the incident was detected. A fraction from 0 to 1. - `rate_delta` (double, required) — `error_rate` minus `baseline_error_rate`. - `rate_multiplier` (double, required, nullable) — `error_rate` / `baseline_error_rate`, or `null` when the baseline is 0. - `is_estimated` (boolean, required) — `true` when the counts are the detector's estimate (incidents longer than 4 hours in List incidents). Get an incident returns exact counts. - `affected_customers` (integer, optional) — Distinct customers with a failed request. Only in Get an incident. ### ErrorIncidentPrimaryError - `error_class` (string, required) - `fingerprint` (string, required, nullable) ## Examples **Request** ```json { "is_acknowledged": true } ``` **Response** ```json { "id": "3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805", "title": "Provider rate limit in prod", "environment": "prod", "fault_domain": "respan", "started_at": "2026-09-30T14:02:00Z", "ended_at": "2026-09-30T14:47:00Z", "duration_seconds": 2700, "data_through_at": "2026-09-30T14:47:00Z", "state": "past", "resolution_reason": "recovered", "severity": "high", "trigger": "spike", "peak_error_rate": 0.42, "baseline_error_rate": 0.012, "error_count": 1840, "request_count": 9620, "hot_bucket_count": 31, "error_class_breakdown": { "provider_rate_limit": 1702, "provider_overloaded": 138 }, "dominant_error_class": "provider_rate_limit", "dominant_fingerprint": null, "impact": { "error_count": 1840, "request_count": 9620, "error_rate": 0.191, "peak_error_rate": 0.42, "baseline_error_rate": 0.012, "rate_delta": 0.179, "rate_multiplier": 15.9, "is_estimated": false }, "primary_error": { "error_class": "provider_rate_limit", "fingerprint": null }, "acknowledged_at": "2026-09-30T14:20:41.902117Z", "is_acknowledged": true, "notes": "", "created_at": "2026-09-30T14:05:12.448210Z", "updated_at": "2026-09-30T14:52:03.118604Z" } ``` **SDK Code** ```python Incidents_updateIncidentAcknowledgement_example import requests url = "https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/" payload = { "is_acknowledged": True } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Incidents_updateIncidentAcknowledgement_example const url = 'https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"is_acknowledged":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Incidents_updateIncidentAcknowledgement_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/" payload := strings.NewReader("{\n \"is_acknowledged\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Incidents_updateIncidentAcknowledgement_example require 'uri' require 'net/http' url = URI("https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"is_acknowledged\": true\n}" response = http.request(request) puts response.read_body ``` ```java Incidents_updateIncidentAcknowledgement_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"is_acknowledged\": true\n}") .asString(); ``` ```php Incidents_updateIncidentAcknowledgement_example request('POST', 'https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/', [ 'body' => '{ "is_acknowledged": true }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Incidents_updateIncidentAcknowledgement_example using RestSharp; var client = new RestClient("https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"is_acknowledged\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Incidents_updateIncidentAcknowledgement_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["is_acknowledged": true] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.respan.ai/api/pulses/incidents/3c9d7e1a-58b2-4f0e-a6d4-91c2b7e3f805/acknowledgement/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```