Skip to main content

resetPackage

Reset a package to its initialized state. This is useful for:

  • Forcing a stuck bundle off the canvas
  • Redeploying a package from scratch
  • Clearing state when delete_state is true

The package's status _will_ be set to INITIALIZED.

By default, the state will not be destroyed. If you want to destroy the state, set delete_state to true. By default, the params will not be cleared. If you want to clear the params, set delete_params to true. By default, the deployments will not be deleted. If you want to delete the deployments, set delete_deployments to true.

This mutation is an escape hatch and can lose data.

Please make sure to pull any state first.

Read our manage state guide on setting up your state backend.

OpenTofu​

> tofu state pull > /somewhere/safe.tfstate

Terraform​

> terraform state pull > /somewhere/safe.tfstate

resetPackage(
  organizationId: ID!
  id: ID!
  deleteState: Boolean!
  deleteParams: Boolean!
  deleteDeployments: Boolean!
): PackagePayload

Arguments​

resetPackage.organizationId ● ID! non-null scalar​

resetPackage.id ● ID! non-null scalar​

Package ID or {project.slug}-{environment.slug}-{manifest.slug} i.e.: ecomm-staging-database

resetPackage.deleteState ● Boolean! non-null scalar​

Destroy the state of the package

resetPackage.deleteParams ● Boolean! non-null scalar​

Clear the params of the package

resetPackage.deleteDeployments ● Boolean! non-null scalar​

Delete deployment history for this package

Type​

PackagePayload object​