Poweroff Shutdown
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Power off the appliance.
Request
URLURL
https://{api_host}/rest/appliance/shutdown/poweroff
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains ShutdownPoweroffRequestBody
of type application/json
(required)
{
"delay": 0,
"reason": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | delay | integer |
Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately. |
| required | reason | string |
Reason for peforming poweroff. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"delay":0,"reason":"string"}' https://{api_host}/rest/appliance/shutdown/poweroff
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
