DEdepot
CIService

CancelJob

Cancels a queued, waiting, or running job and its active attempt.

post/depot.ci.v1.CIService/CancelJob

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 containing the job. Returned by GetRunStatus and ListWorkflows.

jobIdstring required

Unique identifier for the job to cancel. Returned by GetRunStatus and GetWorkflow.

Response

Success

jobIdstring

Unique identifier for the job. Matches the request jobId.

statusstring

Updated job status. Should be "cancelled".

Changes

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