Virtual Machine

Hibernate virtual machine

Initiates the hibernation process for a virtual machine. It saves the current state of the VM to disk, deallocates its resources, and powers it off. Specify the target virtual machine using its ID in the path. Optionally, you can use the retain_ip query parameter to preserve the VM's public IP address during hibernation. For more information about VM hibernation, see Hibernation.

State requirement: This operation requires the VM to be in the ACTIVE state and the flavor to support hibernation. Some flavors (for example, n1-cpu-small) do not.

get/core/virtual-machines/{vm_id}/hibernate

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/hibernate
  • Auth: API key in header api_key

Path parameters

vm_idinteger required

ID of the vm.

Query parameters

retain_ipboolean

When true, the VM's public IP address is kept attached during hibernation. When false, the IP is released and a new one is assigned on restoration.

Response

Hibernation request for the virtual machine was successful.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "status": true,
  "message": "Instance is being deleted."
}

Changes

No recorded changes to this operation across all 1 revision of this API.