CIcircleci
Workflow

Rerun a workflow

Reruns a workflow.

post/workflow/{id}/rerun

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/workflow/{id}/rerun
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

idstring uuid required

The unique ID of the workflow.

Request body

enable_sshboolean

Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.

from_failedboolean

Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.

jobsstring[]

A list of job IDs to rerun.

sparse_treeboolean

Completes rerun using sparse trees logic, an optimization for workflows that have disconnected subgraphs. Requires jobs parameter and so is mutually exclusive with the from_failed parameter.

Example request

{
  "jobs": [
    "c65b68ef-e73b-4bf2-be9a-7a322a9df150",
    "5e957edd-5e8c-4985-9178-5d0d69561822"
  ]
}

Response

A confirmation message.

workflow_idstring uuid required

The ID of the newly-created workflow.

Example response

{
  "workflow_id": "0e53027b-521a-4c40-9042-47e72b3c63a3"
}

Changes

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