PUT /api/hosts/:id/power
Run a power operation on host

Examples

PUT /api/hosts/host1531.example877.com/power
{
  "power_action": "status",
  "host": {}
}
200
{
  "power": "on"
}

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.
power_action
required

power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • Must be a String