Skip to main content

orphanInstance

form schema

Reset an instance back to INITIALIZED, clearing every Terraform/OpenTofu state lock and aborting any in-flight or queued deployments. Optionally deletes the remote IaC state files.

Use this break-glass operation when a deployment is permanently stuck and cannot be recovered through normal retry. State locks are always cleared. Active RUNNING, PENDING, and APPROVED deployments are bulk-aborted so a late worker callback cannot walk the instance status back to PROVISIONED. Pass deleteState: true to also remove the Terraform/OpenTofu state files — this is irreversible and the next deployment will provision from scratch, potentially duplicating any resources that the prior state was tracking.

mutation {
  orphanInstance(
    organizationId: "my-org"
    id: "my-database"
    input: { deleteState: false }
  ) {
    result { id status }
    successful
  }
}
orphanInstance(
  organizationId: ID!
  id: ID!
  input: OrphanInstanceInput!
): InstancePayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

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

Your organization's unique identifier.

orphanInstance.id ● ID! non-null scalar {#id}​

The instance to orphan.

orphanInstance.input ● OrphanInstanceInput! non-null input {#input}​

Reset an instance to INITIALIZED, clearing all of its Terraform/OpenTofu state locks. Optionally also deletes the remote IaC state files.

Type​

InstancePayload object​