GET /api/hosts/:id/power
Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.

Examples

GET /api/hosts/host4.example1.com/power?timeout=30
200
{
  "id": 4,
  "state": "na",
  "title": "N/A",
  "statusText": "Power operations are not enabled on this host."
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
timeout
optional

Timeout to retrieve the power status of the host in seconds. Default is 3 seconds.

Validations:

  • Must be a String