This API has a deprecated equivalent from v7.0U1.
Stage Pending
DescriptionStarts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL
Request
URLURL
https://{api_host}/api/appliance/update/pending/{version}?action=stage
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"
Authentication
This operation uses the following authentication methods.
Errors
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.already_exists : the update is already staged | com.vmware.vapi.std.errors.not_allowed_in_current_state : if appliance update state prevents staging
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
Invoke-StageVersionPending -Version "MyVersion"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/update/pending/{version}?action=stage
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=stage
x-vmw-doc-operation: stage
Availability
Added in 7.0U2
On This Page
Pending Operations
get
get
post
post
post
post
