Method: projects.locations.deliveryPipelines.rollbackTarget

Creates a Rollout to roll back the specified target.

HTTP request

POST https://clouddeploy.googleapis.com/v1/{name=projects/*/locations/*/deliveryPipelines/*}:rollbackTarget

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{projectId}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "targetId": string,
  "rolloutId": string,
  "releaseId": string,
  "rolloutToRollBack": string,
  "rollbackConfig": {
    object (RollbackTargetConfig)
  },
  "validateOnly": boolean,
  "overrideDeployPolicy": [
    string
  ]
}
Fields
targetId

string

Required. ID of the Target that is being rolled back.
rolloutId

string

Required. ID of the rollback Rollout to create.
releaseId

string

Optional. ID of the Release to roll back to. If this isn't specified, the previous successful Rollout to the specified target will be used to determine the Release.
rolloutToRollBack

string

Optional. If provided, this must be the latest Rollout that is on the Target.
rollbackConfig

object (RollbackTargetConfig)

Optional. Configs for the rollback Rollout.
validateOnly

boolean

Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse.
overrideDeployPolicy[]

string

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Response body

The response object from deliveryPipelines.rollbackTarget.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "rollbackConfig": {
    object (RollbackTargetConfig)
  }
}
Fields
rollbackConfig

object (RollbackTargetConfig)

The config of the rollback Rollout created or will be created.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • clouddeploy.rollouts.rollback

For more information, see the IAM documentation.

RollbackTargetConfig

Configs for the Rollback rollout.

JSON representation 
{
  "rollout": {
    object (Rollout)
  },
  "startingPhaseId": string
}
Fields
rollout

object (Rollout)

Optional. The rollback Rollout to create.
startingPhaseId

string

Optional. The starting phase ID for the Rollout. If unspecified, the Rollout will start in the stable phase.