Skip to main content
POST
/
v1
/
remediation
/
{remediationId}
/
execute
Execute remediation
curl --request POST \
  --url https://api.example.com/v1/remediation/{remediationId}/execute

Overview

Executes a previously approved remediation. CauseFlow runs each step in order and tracks progress in real time. The remediation must be in approved status before execution can begin. Required role: admin or owner
Executing a remediation makes changes to your production systems. Verify that the remediation has been reviewed and that you are executing it during an appropriate maintenance window if required.

Path parameters

remediationId
string
required
The unique identifier of the remediation to execute. Must be in approved status. Example: rem_01HX9VTPQR3KF8MZWBYD5N6JCE.

Response

Returns 200 OK when execution has been initiated successfully.
{
  "remediationId": "rem_01HX9VTPQR3KF8MZWBYD5N6JCE",
  "status": "executing"
}
FieldTypeDescription
remediationIdstringThe remediation being executed
statusstringAlways "executing" immediately after a successful execution request
Execution is asynchronous. Poll GET /v1/remediation/ to monitor step-level progress, or listen for the remediation.completed and remediation.failed webhook events.

Status transitions after execution

approved → executing → completed
                     → failed

Error responses

StatusError codeDescription
404remediation_not_foundNo remediation exists with the given ID
403forbiddenThe authenticated user is not an admin or owner
409invalid_statusThe remediation is not in approved status
A remediation must be in approved status before execution. Call POST /v1/remediation//approve first if it is still awaiting approval.

Examples

curl https://api.causeflow.ai/v1/remediation/rem_01HX9VTPQR3KF8MZWBYD5N6JCE/execute \
  -X POST \
  -H "Authorization: Bearer <token>"