virtual_machines

Get virtual machine state

Returns the current power state of the virtual machine.

Requires team role: any

get/teams/{team}/virtual_machines/{vm}/state/

Request

Base URL
https://admin.hotaisle.app/api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/hotaisle/apis/hotaisle/docs/teams/:team/virtual_machines/:vm/state/get.ts
A function with typed inputs. Its response is checked against the schema.

teamstring required

Team handle

vmstring required

Virtual machine name or deployment ID

Current virtual machine state

hoststring required

The host where the VM is running

statestring required

The current state of the virtual machine. Values can include "running", "shut off", "paused", etc.

{
  "host": "vm-host-01",
  "state": "running"
}

No recorded changes to this operation across all 2 revisions of this API.