Workflows

Stop a running workflow

Cancels the active run for the specified workflow. Queued and pending steps are removed from the pipeline; the in-flight step may still complete.

put/v4/workflows/{workflowId}/stop

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/stop
  • Auth: API key in header x-api-key

Path parameters

workflowIdstring required

The ID of the workflow to stop

Response

Workflow stop initiated

messagestring

Example response

{
  "message": "Workflow run is being stopped"
}

Changes

No recorded changes to this operation across all 1 revision of this API.