CIcircleci
Rollback

Rollback a project

Performs a rollback operation by triggering a rollback pipeline.

post/projects/{project_id}/rollback

Request

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

Path parameters

project_idstring required

An opaque identifier of a project.

Request body

component_namestring required

The component name

current_versionstring required

The current version

environment_namestring required

The environment name

namespacestring

The namespace

parametersobject

The extra parameters for the rollback pipeline

reasonstring

The reason for the rollback

target_versionstring required

The target version

Example request

{
  "component_name": "frontend",
  "current_version": "1.0.0",
  "environment_name": "production",
  "namespace": "default",
  "parameters": {
    "param1": "value1",
    "param2": "value2"
  },
  "reason": "The component is down",
  "target_version": "1.0.1"
}

Response

Rollback request accepted.

idstring uuid

The ID of the rollback pipeline or the command created to handle the rollback

rollback_typestring

The type of the rollback

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "rollback_type": "PIPELINE"
}

Changes

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