DEdepot
CIService

CancelRun

Cancels a queued or running CI run and any of its unfinished workflows, jobs, and attempts.

post/depot.ci.v1.CIService/CancelRun

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

runIdstring required

Unique identifier for the CI run. Returned by Run, DispatchWorkflow, and ListRuns.

Response

Success

runIdstring

Unique identifier for the CI run. Matches the request runId.

statusstring

Updated run status. Should be "cancelled".

Changes

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