This API has a deprecated equivalent from v7.0U1.
Validate Pending
Validates the user provided data before the update installation.
Request
URLURL
https://{api_host}/api/appliance/update/pending/{version}?action=validate
Path Parameters
Path 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"
Request Body
Request Body
UpdatePendingValidateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"user_data": {
"key": "string"
}
}
map 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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
Notifications
of type application/json
Issues struct with the issues found during the validation
{
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
]
}
array of
Notification
errors
Optional
Error notification messages reported. Only set if an error was reported by the appliance task.
array of
Notification
info
Optional
Info notification messages reported. Only set if an info was reported by the appliance task.
array of
Notification
warnings
Optional
Warning notification messages reported. Only set if an warning was reported by the appliance task.
Errors
400
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
403
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.
Code Samples
PowerCLI Client SDK Example
$UpdatePendingValidateRequestBody = Initialize-UpdatePendingValidateRequestBody -UserData @{ key_example = "MyInner" }
Invoke-ValidateVersionPending -Version "MyVersion" -UpdatePendingValidateRequestBody $UpdatePendingValidateRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"user_data":{"key":"string"}}' https://{api_host}/api/appliance/update/pending/{version}?action=validate
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/update/pending/{version}?action=validate
x-vmw-doc-operation: validate
Availability
Added in 7.0U2
On This Page
Pending Operations
get
get
post
post
post
post
