REST API - poweroff
  1. Operations
  2. appliance
  3. shutdown

appliance shutdown: poweroff

Power off the appliance. This operation was added in vSphere API 6.7.

Request:

HTTP request

POST https://{server}/rest/appliance/shutdown/poweroff

Request Body Structure:

{
    "reason" : "string",
    "delay" : 1
}

Request Body Parameters:

Name Type Description
bold = required
delay long Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.
reason string Reason for peforming poweroff.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error