---
title: "Change the status of a download"
method: PATCH
path: "/downloads/{id}"
---

# Change the status of a download

`PATCH /downloads/{id}`

## Request

- Base URL: `http://localhost:6286`
- URL: `http://localhost:6286/downloads/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/iconik/apis/agent-api/docs/downloads/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required

## Request body

- PatchDownloadItem: Allows changing the status of a download. Only active and paused are allowed to update.
  - `status` union, required
    - object
      - `type` 'active', required
    - object
      - `type` 'paused', required

## Response `200`

Download item that represents one download of an asset, version, file or file set

- DownloadItem: Download item that represents one download of an asset, version, file or file set
  - `id` string, required
  - `requestItemId` string, required
  - `files` DownloadFileItem[], required: List of files being downloaded as part of this item. An asset or file set can have multiple files associated with it.
    - `fileId` string, required
    - `fileName` string, required
    - `fullPath` string, required
    - `downloaded` number, required
    - `size` number
  - `status` union, required: The different statuses a download item can be in
    - object
      - `type` 'enqueued', required
    - object
      - `type` 'resolving', required
    - object
      - `type` 'active', required
    - object
      - `type` 'paused', required
    - object
      - `type` 'completed', required
    - object
      - `type` 'failed', required
      - `code` string, required
      - `message` string, required
  - `objectIdentity` union, required: Object to identify what to download
    - DownloadAssetItemIdentity
      - `type` 'asset', required
      - `id` string, required
      - `formatId` string
      - `outputPath` string
    - DownloadAssetFileSetItemIdentitySchema
      - `type` 'fileSet', required
      - `id` string, required
      - `assetId` string, required
    - DownloadAssetVersionItemIdentity
      - `type` 'assetVersion', required
      - `versionId` string, required
      - `assetId` string, required
      - `formatId` string
    - DownloadAssetFileItemIdentity
      - `type` 'assetFile', required
      - `assetId` string, required
      - `id` string, required
      - `outputPath` string

---

[API](https://skmtc.dev/iconik/apis/agent-api.md) - [All operations](https://skmtc.dev/iconik/apis/agent-api/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/agent-api/revisions/cd5eb7819e60?raw)