Skip to main content
GET
/
v1
/
remediation
/
{incidentId}
List remediations
curl --request GET \
  --url https://api.example.com/v1/remediation/{incidentId}

Documentation Index

Fetch the complete documentation index at: https://docs.causeflow.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Returns all proposed remediations for a given incident. Each remediation includes a description of what will be done, its current status, and the individual steps involved. Required role: admin or member

​
Path parameters

​
incidentId
string
required
The unique identifier of the incident whose remediations you want to list. Example: inc_01HX9VTPQR3KF8MZWBYD5N6JCE.

​
Response

Returns 200 OK with an array of remediations for the incident. 
{
  "remediations": [
    {
      "remediationId": "rem_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "status": "awaiting_approval",
      "description": "Create a composite index on the orders table to resolve the full table scan causing the latency spike.",
      "steps": [
        {
          "type": "sql_migration",
          "status": "pending",
          "description": "CREATE INDEX CONCURRENTLY idx_orders_tenant_created ON orders (tenant_id, created_at DESC);"
        },
        {
          "type": "verification",
          "status": "pending",
          "description": "Verify query execution plan uses new index and P99 latency returns below 100ms."
        }
      ]
    },
    {
      "remediationId": "rem_01HX9VTPQR3KF8MZWBYD5N6JCF",
      "status": "awaiting_approval",
      "description": "Roll back deploy d9f3a21 to restore the index hint removed in the OrderRepository query builder.",
      "steps": [
        {
          "type": "deployment_rollback",
          "status": "pending",
          "description": "Roll back checkout-service to v2.4.0 (commit a8b3c2d)."
        }
      ]
    }
  ]
}
FieldTypeDescription
remediationsarrayAll proposed remediations for the incident
remediations[].remediationIdstringUnique identifier for this remediation
remediations[].statusstringCurrent status: awaiting_approval, approved, rejected, executing, completed, failed
remediations[].descriptionstringSummary of what this remediation does
remediations[].stepsarrayOrdered list of individual steps within this remediation
steps[].typestringStep type, e.g. sql_migration, deployment_rollback, verification
steps[].statusstringStep status: pending, running, completed, failed
steps[].descriptionstringWhat this step does
Returns 404 Not Found if the incident does not exist.

​
Examples

curl https://api.causeflow.ai/v1/remediation/inc_01HX9VTPQR3KF8MZWBYD5N6JCE \
  -H "Authorization: Bearer <token>"