CIService

RetryFailedJobs

Retries the failed and cancelled jobs in a workflow, along with every job that depends on them. A dependent that already succeeded or was skipped runs again too, because a job it consumed is running again. Queued dependents are left untouched, since they re-check their dependencies before starting. Fails without resetting anything when a waiting or running job depends on the retried set; wait for that job to finish, or cancel the workflow and use RerunWorkflow.

post/depot.ci.v1.CIService/RetryFailedJobs

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 failed jobs. Returned by GetRunStatus and ListWorkflows.

Response

Success

workflowIdstring

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

jobIdsstring[]

Unique identifiers for jobs that were set back to queued. A new attempt is created for each job when it runs again.

jobCountinteger

Number of jobs reset to queued. Includes the failed and cancelled jobs, plus every job that depends on them, whether it previously succeeded or was skipped. Equal to the number of entries in the jobIds array.

Changes

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