Skip to main content

Stop Virtual Machine

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

Shuts down a virtual machine. Provide the virtual machine ID in the path to initiate the shutdown process for the specified virtual machine.


Path parameters​

id integer   Required​

The unique identifier of the virtual machine to be shutdown.


Attributes​

status boolean​

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

message string​

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

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

Returns​

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


Back to top​