jobs

Cancel a Cloudflare Workflow run created through kody:runtime workflows.create by id.

Cancel a Cloudflare Workflow run created through kody:runtime workflows.create by id. Terminates the underlying workflow instance and marks the run cancelled; cancelling an already-finished run is a safe no-op.

Org permission: job:execute.

post/v1/workflow-runs/{id}/cancel

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/workflow-runs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Workflow run id from workflowRunList or workflows.create output (dynwf-… inline runs or pkgwf-… package runs).

Request body

object required

Response

Success.

idstring required
cancelledboolean required
already_terminalboolean required
status'queued' | 'running' | 'paused' | 'waiting' | 'waitingForPause' | 'unknown' | 'complete' | 'errored' | 'terminated' | 'cancelled' nullable required
messagestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.