CIService

RerunWorkflow

Resets every job in a workflow that's in a terminal state (finished, failed, or cancelled) to queued and runs them all again. Cancel the workflow first if it's still running.

post/depot.ci.v1.CIService/RerunWorkflow

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 re-run. Returned by GetRunStatus and ListWorkflows.

Response

Success

workflowIdstring

Unique identifier for the workflow. Matches the request workflowId. A re-run creates a new workflow execution rather than a new workflow.

jobCountinteger

Number of jobs reset to queued. A re-run resets every job in the workflow, so this is the workflow's total job count.

Changes

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