Install Update

Install Update
Install the update.

Install the update.

Request
URI
POST
https://{api_host}/appliance/update-manager/updates/{update_version}/actions/install
COPY
Path Parameters
string
update_version
Required

The version of an update to be installed.

Authentication
This operation uses the following authentication methods.
Responses
202

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.

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task , InlineTaskDrResponseEntity1 
{
    "id": "string",
    "description": "string",
    "type": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "result": {},
    "progress": 0,
    "start_time": 0,
    "complete_time": 0,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}

400

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

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/appliance/update-manager/updates/{update_version}/actions/install
On This Page
Updates Operations
POST
Get Updates
GET
Get Updates Repository
PUT
Change Updates Repository
GET
Get Rollback Snapshot
DELETE
Delete Rollback Snapshot
POST
Apply Rollback Snapshot
POST
Install Update