Skip to main content

Hibernate Virtual Machine

GET https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{id}/hibernate​

Initiates the hibernation of a virtual machine, saving its current state to disk before deallocating resources and powering off. Provide the virtual machine ID in the path to specify the virtual machine to be hibernated. To learn more about virtual machine hibernation, click here.


Path parameters​

id integer   Required​

The unique identifier of the virtual machine to be hibernated.


Attributes​

status boolean​

Indicates the result of the request to hibernate the VM. true signifies success, while false indicates an error.

message string​

A description of the status of the request to hibernate the VM.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{id}/hibernate" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "string"
}

Returns​

Returns the status of the request to hibernate the virtual machine. A true status indicates success, otherwise an error has occurred.


Back to top​