Virtual Machine

Stop virtual machine

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

State requirement: This operation requires the VM to be in the ACTIVE or ERROR state.

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

Request

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

Path parameters

vm_idinteger required

ID of the vm.

Response

Virtual machine shut down successfully.

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.