---
title: "Create ZIP archive"
method: POST
path: "/patients/{id}/archive"
tags: ["Patients"]
---

# Create ZIP archive

`POST /patients/{id}/archive`

Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL

## Path parameters

- `id` string, required

## Request body

- object
  - `Asynchronous` boolean — If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
  - `Priority` number — In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
  - `Synchronous` boolean — If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.
  - `Transcode` string — If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html

## Response `200`

- object — In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs
  - `ID` string — Identifier of the job
  - `Path` string — Path to access the job in the REST API

---

[API](https://skmtc.net/orthancserver/apis/orthanc-server.md) · [All operations](https://skmtc.net/orthancserver/apis/orthanc-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orthancserver/orthanc-server/versions/af646f6f871b/schema)