API REFERENCE

Workflow Runs API

A run is a single execution of a published workflow definition. Use this API to start runs, drive their lifecycle, and inspect their progress.

Run and control

Start a run with POST /workflow-runs (referencing a workflow definition), then control it with the cancel, retry, replay, resume, and requeue actions. Inspect state with GET /workflow-runs/{runId}/steps and .../timeline, and browse the dead-letter, latest, and summary listings.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.

GET/api/workflow-runsAlgaPSAList workflow runsPOST/api/workflow-runsAlgaPSAStart a workflow runGET/api/workflow-runs/{runId}AlgaPSAGet a workflow runGET/api/workflow-runs/{runId}/auditAlgaPSAGet workflow run audit logGET/api/workflow-runs/{runId}/audit/exportAlgaPSAExport workflow run audit logPOST/api/workflow-runs/{runId}/cancelAlgaPSACancel a workflow runGET/api/workflow-runs/{runId}/exportAlgaPSAExport a workflow runPOST/api/workflow-runs/{runId}/replayAlgaPSAReplay a workflow runPOST/api/workflow-runs/{runId}/requeueAlgaPSARequeue a workflow runPOST/api/workflow-runs/{runId}/resumeAlgaPSAResume a workflow runPOST/api/workflow-runs/{runId}/retryAlgaPSARetry a failed workflow runGET/api/workflow-runs/{runId}/stepsAlgaPSAGet workflow run stepsGET/api/workflow-runs/{runId}/summaryAlgaPSAGet workflow run summaryGET/api/workflow-runs/{runId}/timelineAlgaPSAGet workflow run timelineGET/api/workflow-runs/dead-letterAlgaPSAList dead-lettered runsGET/api/workflow-runs/exportAlgaPSAExport workflow runsGET/api/workflow-runs/latestAlgaPSAGet latest workflow runsGET/api/workflow-runs/summaryAlgaPSAGet workflow runs summary