Skip to main content
GET
/
v1
/
remediation
/
{remediationId}
Get remediation detail
curl --request GET \
  --url https://api.example.com/v1/remediation/{remediationId} \
  --header 'Authorization: <authorization>'

​
Overview

Returns the complete detail for a single remediation, including the AI-proposed plan, step-by-step execution log, approval history, and final outcome. Required role: admin or member

​
Request headers

​
Authorization
string
required
JWT Bearer token. Format: Bearer <your-jwt>.

​
Path parameters

​
remediationId
string
required
The unique identifier of the remediation. Example: rem_01HX9VTPQR3KF8MZWBYD5N6JCE.

​
Response

Returns 200 OK with the full remediation object. 
{
  "remediationId": "rem_01HX9VTPQR3KF8MZWBYD5N6JCE",
  "incidentId": "inc_EXAMPLE_01JX",
  "title": "Scale payment processor connection pool from 50 to 150",
  "status": "executed",
  "requiresApproval": true,
  "approvedBy": "user_01HX9VTPQR3KF8MZWBYD5N6JCE",
  "approvedAt": "2024-04-01T14:36:00Z",
  "steps": [
    {
      "stepId": "step_01",
      "description": "Update ECS task definition — increase `DB_POOL_SIZE` from 50 to 150",
      "status": "completed",
      "completedAt": "2024-04-01T14:37:00Z",
      "output": "Task definition arn:aws:ecs:us-east-1:<your-aws-account-id>:task-definition/checkout-service:47 registered"
    },
    {
      "stepId": "step_02",
      "description": "Trigger rolling deploy of checkout-service",
      "status": "completed",
      "completedAt": "2024-04-01T14:37:30Z",
      "output": "3/3 tasks replaced successfully"
    }
  ],
  "outcome": "resolved",
  "proposedAt": "2024-04-01T14:35:00Z",
  "executedAt": "2024-04-01T14:37:30Z"
}
FieldTypeDescription
remediationIdstringUnique identifier
incidentIdstringRelated incident
titlestringShort description of the remediation action
statusstringOne of: proposed, approved, executing, executed, rejected, failed
requiresApprovalbooleanWhether human approval was required
approvedBystringUser ID who approved. null if not yet approved
stepsarrayOrdered list of execution steps with status and output
outcomestringFinal outcome: resolved, partial, failed. null if not yet executed
proposedAtstringISO 8601 timestamp
executedAtstringISO 8601 timestamp. null if not yet executed

​
Error responses

StatusError codeDescription
401unauthorizedMissing or invalid JWT
403forbiddenCaller lacks required role
404remediation_not_foundNo remediation with the given ID

​
Examples

curl https://api.causeflow.ai/v1/remediation/rem_01HX9VTPQR3KF8MZWBYD5N6JCE \
  -H "Authorization: Bearer eyJhbGc..."

Approve remediation

Approve the remediation plan for execution

Submit feedback

Rate the effectiveness of a completed remediation