Get Updates

Get Updates

Get all available updates in the repository.

Request
URI
POST
https://{api_host}/appliance/update-manager/actions/retrieve-updates
COPY
Authentication
This operation uses the following authentication methods.
Responses
202

A task to track the progress of the operation. List of the available updates will be returned in the result field of the task, once completed.

Returns Task of type(s) application/json
{
    "id": "string",
    "description": "string",
    "type": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "start_time": 0,
    "complete_time": 0
}
string
id
Optional

ID of the task.

string
description
Optional

Description of the task.

string
type
Optional

Operation type of the task.

string
status
Required

Status of the task.

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

error

object
result
Optional

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

integer As int32 As int32
progress
Optional

The current progress of the task, in percentage number.

integer As int64 As int64
start_time
Optional

The start time of the task, in milliseconds.

integer As int64 As int64
complete_time
Optional

The complete time of the task, in milliseconds.


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

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.


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

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.