REST API - install
  1. Operations
  2. appliance
  3. update
  4. pending

appliance update pending: install

Starts operation of installing the appliance update. Will fail is the update is not staged. This operation was added in vSphere API 6.7.

Request:

HTTP request

POST https://{server}/rest/appliance/update/pending/{version}?action=install

Path Parameters

Name Type Description
Required
version string Update version.

Request Body Structure:

{
    "user_data" : [
        {
            "value" : "string",
            "key" : "obj-103"
        }
    ]
}

Request Body Parameters:

Name Type Description
bold = required
user_data list map of user provided data with IDs. List of {"key": string, "value": string}
user_data[].key string
user_data[].value string

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation
404 not_found if the update is not found
400 already_in_desired_state if the update of this version is already installed
400 not_allowed_in_current_state if appliance update state prevents running an update or not staged