Install Update

Install 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.

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 Task of type(s) application/json 
{
    "id": "string",
    "description": "string",
    "type": "string",
    "status": "string",
    "error": {
        "cause": {
            "stack_trace": [
                {
                    "class_loader_name": "string",
                    "module_name": "string",
                    "module_version": "string",
                    "method_name": "string",
                    "file_name": "string",
                    "line_number": 0,
                    "class_name": "string",
                    "native_method": false
                }
            ],
            "message": "string",
            "suppressed": [
                {
                    "stack_trace": [
                        {
                            "class_loader_name": "string",
                            "module_name": "string",
                            "module_version": "string",
                            "method_name": "string",
                            "file_name": "string",
                            "line_number": 0,
                            "class_name": "string",
                            "native_method": false
                        }
                    ],
                    "message": "string",
                    "localized_message": "string"
                }
            ],
            "localized_message": "string"
        },
        "stack_trace": [
            {
                "class_loader_name": "string",
                "module_name": "string",
                "module_version": "string",
                "method_name": "string",
                "file_name": "string",
                "line_number": 0,
                "class_name": "string",
                "native_method": false
            }
        ],
        "message": "string",
        "suppressed": [
            {
                "stack_trace": [
                    {
                        "class_loader_name": "string",
                        "module_name": "string",
                        "module_version": "string",
                        "method_name": "string",
                        "file_name": "string",
                        "line_number": 0,
                        "class_name": "string",
                        "native_method": false
                    }
                ],
                "message": "string",
                "localized_message": "string"
            }
        ],
        "localized_message": "string"
    },
    "progress": 0,
    "start_time": "string",
    "complete_time": "string"
}
string
id
Optional

id

string
description
Optional

description

string
type
Optional

Operation type

string
status
Required

Current status of the task

Possible values are : QUEUED, RUNNING, SUCCESS, ERROR, CANCELLED,
TaskError
error
Optional

error

object
result
Optional

Result of the operation

integer As int32 As int32
progress
Optional

Current progress of the operation

string As date-time As date-time
start_time
Optional

start_time

string As date-time As date-time
complete_time
Optional

complete_time


400

Bad request - the server could not 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

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


On This Page
Updates Operations
PUT
Change Updates Repository
POST
Get Updates
GET
Get Updates Repository
POST
Install Update