Validate Pending
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Validates the user provided data before the update installation.
Request
URLURL
https://{api_host}/rest/appliance/update/pending/{version}?action=validate
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, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
UpdatePendingValidateRequestBody of type application/json (required){
"user_data": [
"string"
]
}
array of
string
user_data
Required
map of user provided data with IDs The key in the parameter map must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.
Response
Response
Response BodyResponse Body
200 OK returns
UpdatePendingValidateResponseBody
of type application/json
Issues struct with the issues found during the validation
{
"value": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
}
}cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"user_data":["string"]}' https://{api_host}/rest/appliance/update/pending/{version}?action=validate
Errors
404
com.vmware.vapi.std.errors.error : Generic error | com.vmware.vapi.std.errors.not_found : if the update is not found
409
com.vmware.vapi.std.errors.already_in_desired_state : if the update of this version is already installed | com.vmware.vapi.std.errors.not_allowed_in_current_state : if appliance update state prevents running an check
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
On This Page
Pending Operations
get
get
post
post
post
post
