Get Update
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Gets the current status of the appliance update.
Request
URLURL
https://{api_host}/rest/appliance/update
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
UpdateGetResponseBody
of type application/json
Info structure containing the status information about the appliance.
{
"value": {
"latest_query_time": "string",
"state": "enum",
"task": {
"cancelable": false,
"end_time": "string",
"operation": "string",
"parent": "string",
"service": "string",
"start_time": "string",
"subtask_order": [
"string"
],
"subtasks": [
{
"key": "key1",
"value": {
"cancelable": false,
"end_time": "string",
"operation": "string",
"parent": "string",
"result": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"service": "string",
"start_time": "string",
"user": "string"
}
}
],
"user": "string"
},
"version": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| value | UpdateInfo |
Info structure containing the status information about the appliance. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/update
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : session is not authenticated | com.vmware.vapi.std.errors.unauthorized : session is not authorized to perform this operation |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
On This Page
Update Operations
get
post
