Skip to main content

destroyEnvironment

DESTRUCTIVE and IRREVERSIBLE. Tears down all cloud resources for the environment (per-tenant Postgres, game-api, Buddy, and load-balancer VMs plus DNS records) and revokes its service tokens; all tenant data is lost. Sets status to 'destroy_requested' and returns the tracking change order — poll orgEnvironment.destroyProgress. Fails if a destroy is already queued. After it reaches 'destroyed', call purgeEnvironment to remove the record. Requires the 'manage_environments' org permission.

destroyEnvironment(
input: DestroyEnvironmentInput!
): CksEnvironmentChangeOrder!

Arguments

destroyEnvironment.input ● DestroyEnvironmentInput! non-null input

Type

CksEnvironmentChangeOrder object

An asynchronous change order tracking a deploy / destroy / scaling pipeline for an environment. Returned by mutations so callers can poll completion.