Managing VMs

Once a VM exists, you can list and inspect your VMs and control a VM's runtime state by sending it commands.

Listing VMs

• List VMs in your Cloud:

  • GET /v3/flexVM/clouds/{cloudUuid}/vms

  • Optionally filter by status with the status query parameter (e.g. ?status=running).

  • Supports the RANGED-DATA header for pagination.

• Get a specific VM:

  • GET /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}

  • Returns the details of the specified VM, including its current status.

Executing commands

Use the POST /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}/commands endpoint to change a VM's runtime state. The request body takes a single command field.

Command	Description
start	Power on a stopped VM (stopped → starting → running).
stop	Gracefully shut down a running VM (running → stopping → stopped).
reboot	Gracefully restart a running VM.
reset	Forcefully power-cycle the VM. Use this when the VM is unresponsive and reboot does not work.

Example request:

POST /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}/commands
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json

{
  "command": "reboot"
}

Response (202 Accepted) indicates the command was accepted. The command is applied asynchronously — poll the VM with GET /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid} to follow its status.

For creating and deleting VMs, see Creating and Deleting a VM.