boot.environment.destroy

Permanently destroy the boot environment identified by id, freeing the space it consumes.

The active (currently running) and activated (next boot) boot environments cannot be destroyed; attempting to do so returns an EINVAL error.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: boot_environment_destroy

boot_environment_destroy

Type: object

BootEnvironmentDestroyArgs parameters.

No Additional Properties

id Required

Id

Type: string

Must be at least 1 characters long

Return value

Result

Type: null

Required roles: BOOT_ENV_WRITE