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

appliance shutdown: get

Get details about the pending shutdown action. This operation was added in vSphere API 6.7.

Request:

HTTP request

GET https://{server}/rest/appliance/shutdown
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "reason" : "string",
        "action" : "string",
        "shutdown_time" : "2015-01-01T22:13:05.651Z"
    }
}

Response Type:

Name Type Description
bold = required
value shutdown_config Configuration of pending shutdown action.
value.shutdown_time date_time Shutdown time. This attribute was added in vSphere API 6.7.

Optional. shutdownTime Optional value of pending shutdown time.

value.action string The pending shutdown operation. The string values for pending operations can be 'poweroff', 'reboot' or ''. This attribute was added in vSphere API 6.7.
value.reason string The reason behind the shutdown action. This attribute was added in vSphere API 6.7.

Errors:

HTTP Status Code Type Description
500 error Generic error