[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api

Install Update

Description

Install the update.

Request

Request

URL

URL


post
https://{api_host}//appliance/update-manager/updates/{update_version}/actions/install
Copy

Path Parameters

Path Parameters

string
update_version Required

The version of an update to be installed.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns Task of type application/json

A task to monitor the update. Since an update might restart any service and/or the appliance, it’s possible to not be able to monitor the progress of the resulted task.

{
	"complete_time": 0,
	"description": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED",
	"type": "string"
}
string
status Required

Status of the task.

Possible values are: QUEUEDRUNNINGSUCCESSERRORCANCELLED


integer as int64
complete_time Changed Optional

The complete time of the task, in milliseconds.


error Optional

Detailed information about the error if the task status is ERROR.


string
id Optional

ID of the task.


integer as int32
progress Optional

The current progress of the task, in percentage number.


object
result Optional

Information about the task result if the task status is SUCCESS.


integer as int64
start_time Changed Optional

The start time of the task, in milliseconds.


string
description Optional

Description of the task.


string
type Optional

Operation type of the task.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST https://{api_host}/appliance/update-manager/updates/{update_version}/actions/install


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
Feedback

Was this page helpful?