boot.environment.destroy

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

The active (currently running) boot environment cannot be destroyed; attempting to do so returns a JSON-RPC error response (code -32602, Invalid params).

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: boot_environment_destroy

boot_environment_destroy

Type: object

BootEnvironmentDestroyArgs parameters.

 No Additional Properties

Id

Type: string

Name of the boot environment to destroy.

Must be at least 1 characters long

Result

Type: null

Returns null when the boot environment is successfully destroyed.


Required roles: BOOT_ENV_WRITE