Skip to main content

rollbackDeployment

Propose a rollback to a past deployment's exact state.

Takes the source deployment — the historical run you want to return to — and creates a new PROPOSED PROVISION deployment that snapshots the source's params, connection wiring, bundle version, and release. The source must be a COMPLETED PROVISION deployment.

The rollback proposal can be approved (approveDeployment), rejected (rejectDeployment), or planned (planDeployment) like any other proposed deployment. On approval, the instance is pinned to the source deployment's exact bundle version, params, and connection snapshot — overriding whatever release is currently configured.

mutation {
  rollbackDeployment(
    organizationId: "my-org"
    id: "550e8400-e29b-41d4-a716-446655440000"
  ) {
    result { id status action message }
    successful
    messages { field message }
  }
}
rollbackDeployment(
  organizationId: ID!
  id: UUID!
): DeploymentPayload

Arguments​

rollbackDeployment.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

rollbackDeployment.id ● UUID! non-null scalar {#id}​

The completed deployment to roll back to.

Type​

DeploymentPayload object​