Skip to content
SYLVE

Delete Download

DELETE
/utilities/downloads/{id}
curl --request DELETE \
  --url https://sylve.lan:8181/api/utilities/downloads/1 \
  --header 'Authorization: <Authorization>'

Delete one download after reference, activity, and managed-path preflight; unexpected cleanup failures return a typed retained-path result

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer
>= 1

Download ID

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
deleted
Array<object>
object
id
integer
name
string
type
string
Allowed values: http torrent path
uuid
string
failed
Array<object>
object
code
string
id
integer
name
string
retainedPaths
Array<string>
type
string
Allowed values: http torrent path
uuid
string
vmReferences
Array<object>
object
storageId
integer
vmId
integer
vmName
string
vmRid
integer
error
string
message
string
status
string
Example
{
  "data": {
    "deleted": [
      {
        "type": "http"
      }
    ],
    "failed": [
      {
        "type": "http"
      }
    ]
  }
}

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"
}

404

Section titled “404”

Download not found

Media typeapplication/json
object
data
object
deleted
Array<object>
object
id
integer
name
string
type
string
Allowed values: http torrent path
uuid
string
failed
Array<object>
object
code
string
id
integer
name
string
retainedPaths
Array<string>
type
string
Allowed values: http torrent path
uuid
string
vmReferences
Array<object>
object
storageId
integer
vmId
integer
vmName
string
vmRid
integer
error
string
message
string
status
string
Example
{
  "data": {
    "deleted": [
      {
        "type": "http"
      }
    ],
    "failed": [
      {
        "type": "http"
      }
    ]
  }
}

409

Section titled “409”

Download active, referenced, or unsafe to clean

Media typeapplication/json
object
data
object
deleted
Array<object>
object
id
integer
name
string
type
string
Allowed values: http torrent path
uuid
string
failed
Array<object>
object
code
string
id
integer
name
string
retainedPaths
Array<string>
type
string
Allowed values: http torrent path
uuid
string
vmReferences
Array<object>
object
storageId
integer
vmId
integer
vmName
string
vmRid
integer
error
string
message
string
status
string
Example
{
  "data": {
    "deleted": [
      {
        "type": "http"
      }
    ],
    "failed": [
      {
        "type": "http"
      }
    ]
  }
}

500

Section titled “500”

Cleanup or persistence failure

Media typeapplication/json
object
data
object
deleted
Array<object>
object
id
integer
name
string
type
string
Allowed values: http torrent path
uuid
string
failed
Array<object>
object
code
string
id
integer
name
string
retainedPaths
Array<string>
type
string
Allowed values: http torrent path
uuid
string
vmReferences
Array<object>
object
storageId
integer
vmId
integer
vmName
string
vmRid
integer
error
string
message
string
status
string
Example
{
  "data": {
    "deleted": [
      {
        "type": "http"
      }
    ],
    "failed": [
      {
        "type": "http"
      }
    ]
  }
}