DEdepot
CIService

CancelWorkflow

Cancels a queued or running workflow and all its child jobs.

post/depot.ci.v1.CIService/CancelWorkflow

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

workflowIdstring required

Unique identifier for the workflow to cancel. Returned by GetRunStatus and ListWorkflows.

Response

Success

workflowIdstring

Unique identifier for the workflow. Matches the request workflowId.

statusstring

Updated workflow status. Should be "cancelled".

Changes

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