Cancel a workflow run

Stops the run and marks its waits as canceled.

RBAC · workflow

Path parameters

runIdstringRequired

Request body

Content type: application/json · schema WorkflowRunActionBody

reasonstring

Audit reason for the action.

sourcestring

Origin label; defaults to 'api'.

Response body

Success response 200 · schema UnversionedV1Success

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Cancel a workflow run succeeded.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

404

Run not found.

500

Unexpected error.

POST /api/workflow-runs/{runId}/cancel

cURL

curl -X POST "https://algapsa.com/api/workflow-runs/{runId}/cancel" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string",
  "source": "string"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/workflow-runs/{runId}/cancel", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": "string",
    "source": "string"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/workflow-runs/{runId}/cancel");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""reason"": ""string"",
  ""source"": ""string""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}