Get Pending
Released in v6.7 DescriptionGets update information
Request
URLURL
https://{api_host}/rest/appliance/update/pending/{version}
Parameters
Parameters
string
version
Required
Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.
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
UpdatePendingGetResponseBody
of type application/json
{
"value": {
"contents": [
{
"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"
}
}
]
}
],
"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"
}
}
]
},
"eulas": [
{
"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"
}
}
]
}
],
"knowledge_base": "string",
"name": "string",
"priority": "enum",
"reboot_required": false,
"release_date": "string",
"services_will_be_stopped": [
{
"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"
}
}
]
},
"service": "string"
}
],
"severity": "enum",
"size": 0,
"staged": false,
"update_type": "enum"
}
}
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/update/pending/{version}
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
404
com.vmware.vapi.std.errors.error : Generic error | com.vmware.vapi.std.errors.not_found : the update is not found
409
com.vmware.vapi.std.errors.already_in_desired_state : if the update of this version is already installed
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
Pending Operations
get
get
post
post
post
post