Get Update
Released in v6.7Gets the current status of the appliance update.
Request
URLURL
https://{api_host}/rest/appliance/update
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
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,
"description": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"end_time": "string",
"operation": "string",
"parent": "string",
"progress": {
"completed": 0,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"total": 0
},
"service": "string",
"start_time": "string",
"status": "enum",
"subtask_order": [
"string"
],
"subtasks": [
{
"key": "key1",
"value": {
"cancelable": false,
"description": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"end_time": "string",
"operation": "string",
"parent": "string",
"progress": {
"completed": 0,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"total": 0
},
"result": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"Std_NestedLocalizableMessage": "Too large to render past this point..."
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"Std_NestedLocalizableMessage": "Too large to render past this point..."
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"Std_NestedLocalizableMessage": "Too large to render past this point..."
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"Std_NestedLocalizableMessage": "Too large to render past this point..."
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"Std_NestedLocalizableMessage": "Too large to render past this point..."
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"Std_NestedLocalizableMessage": "Too large to render past this point..."
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
]
},
"service": "string",
"start_time": "string",
"status": "enum",
"target": {
"id": "string",
"type": "string"
},
"user": "string"
}
}
],
"target": {
"id": "string",
"type": "string"
},
"user": "string"
},
"version": "string"
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/update
Errors
401
com.vmware.vapi.std.errors.unauthenticated : session is not authenticated | com.vmware.vapi.std.errors.unauthorized : session is not authorized to perform this operation
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
On This Page
Update Operations
get
post
