Skip to main content

purgeEnvironment

DESTRUCTIVE. Permanently deletes a destroyed environment's record and all cascaded metadata from the platform; returns true on success. The environment must already be in status 'destroyed' (run destroyEnvironment first) and must not have deletion protection enabled, otherwise this fails. Does not touch cloud resources. Requires the 'manage_environments' org permission.

purgeEnvironment(
  input: PurgeEnvironmentInput!
): Boolean!

Arguments​

purgeEnvironment.input ● PurgeEnvironmentInput! non-null input​

Type​

Boolean scalar​

The Boolean scalar type represents true or false.