Update Download

PATCH

/utilities/downloads/{id}

curl --request PATCH \
  --url https://sylve.lan:8181/api/utilities/downloads/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "automaticExtraction": true, "automaticRawConversion": true, "name": "example", "uType": "base-rootfs" }'

Partially update completed or failed download display metadata and processing options; active downloads cannot be changed

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

integer

>= 1

Download ID

Request Body

Update Download Request

Media typeapplication/json

object

automaticExtraction

boolean

automaticRawConversion

boolean

name

string

uType

string

Allowed values: base-rootfs cloud-init uncategorized

Responses

200

Success

Media typeapplication/json

object

data

object

automaticExtraction

boolean

automaticRawConversion

boolean

createdAt

string

error

string

extractedPath

string

files

Array<object>

object

download

object recursive

downloadId

integer

id

integer

name

string

size

integer

id

integer

ignoreTLS

boolean

name

string

path

string

progress

integer

size

integer

status

string

Allowed values: pending processing done failed

type

string

Allowed values: http torrent path

uType

string

Allowed values: base-rootfs cloud-init uncategorized

updatedAt

string

url

string

uuid

string

error

string

message

string

status

string

Example

{
  "data": {
    "status": "pending",
    "type": "http",
    "uType": "base-rootfs"
  }
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Download not found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Download is active

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request body too large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

422

Unsupported metadata or processing options

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Queue unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}