Skip to content
SYLVE

Start Download

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

Persist and queue a download from a magnet URI, HTTP(S) URL, or readable regular absolute path

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Download request

Media typeapplication/json
object
automaticExtraction
boolean
automaticRawConversion
boolean
downloadType
string
Allowed values: base-rootfs cloud-init uncategorized
filename
string
ignoreTLS
boolean
url
required
string

Responses

Section titled “Responses”

202

Section titled “202”

Accepted

Media typeapplication/json
object
data
object
id
integer
status
string
Allowed values: pending processing done failed
error
string
message
string
status
string
Example
{
  "data": {
    "status": "pending"
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Download or destination already exists

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request body too large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

422

Section titled “422”

Unsupported source or processing options

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Queue unavailable

Media typeapplication/json
object
data
object
id
integer
status
string
Allowed values: pending processing done failed
error
string
message
string
status
string
Example
{
  "data": {
    "status": "pending"
  }
}