---
title: "Start Download"
method: POST
path: "/utilities/downloads"
tags: ["Utilities"]
---

# Start Download

`POST /utilities/downloads`

## Request

- Base URL: `https://sylve.lan:8181/api`
- URL: `https://sylve.lan:8181/api/utilities/downloads`
- Auth: API key in header `Authorization`

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

## Request body

- GithubComAlchemillahqSylveInternalInterfacesServicesUtilitiesDownloadFileRequest
  - `automaticExtraction` boolean
  - `automaticRawConversion` boolean
  - `downloadType` 'base-rootfs' | 'cloud-init' | 'uncategorized'
  - `filename` string
  - `ignoreTLS` boolean
  - `storagePool` string
  - `url` string, required

## Response `202`

Accepted

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalInterfacesServicesUtilitiesDownloadStartResult
  - `data` GithubComAlchemillahqSylveInternalInterfacesServicesUtilitiesDownloadStartResult
    - `id` integer
    - `status` 'pending' | 'processing' | 'done' | 'failed'
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `409`: Download or destination already exists
- `413`: Request body too large
- `422`: Unsupported source or processing options
- `500`: Internal Server Error
- `503`: Queue unavailable

## Changes

- **2026-08-12** `9a5026bf9057`: 1 breaking, 7 info
  - removed the success response with the status `200`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - added the non-success response with the status `409`
  - …4 more
- **2025-05-26** `597f6a4102c6`: 1 info
  - endpoint added
- **2025-03-11** `2b736ca1b025`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/utilities/downloads/post.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) - [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/9565cdd0abf5?raw)