# \#rest-api

**URL:** https://discourse.orthanc-server.org/tag/rest-api/1.md

[Latest](https://discourse.orthanc-server.org/latest.md) · [Categories](https://discourse.orthanc-server.org/categories.md) · [Tags](https://discourse.orthanc-server.org/tags.md)

---

## [Fixing Prometheus metrics contribution](https://discourse.orthanc-server.org/t/fixing-prometheus-metrics-contribution/6490)

<div class="topic-metadata">

**Author:** [@Sergei](https://discourse.orthanc-server.org/u/Sergei)\
**Replies:** 1\
**Last updated:** [October 20, 2026, 1:41pm UTC](https://discourse.orthanc-server.org/t/fixing-prometheus-metrics-contribution/6490 "2026-10-20T13:41:38Z")

</div>

Hello Team, I was configuring Grafana metrics collection and found that tools/metrics-prometheus returns the same value for orthanc\_uncompressed\_size\_mb and orthanc\_disk\_size\_mb. So I prepared a small patch to fix this …

---

## [Orthanc python plugin that adds a GraphQL layer to reduce REST query overhead](https://discourse.orthanc-server.org/t/orthanc-python-plugin-that-adds-a-graphql-layer-to-reduce-rest-query-overhead/6472)

<div class="topic-metadata">

**Author:** [@TReniers](https://discourse.orthanc-server.org/u/TReniers)\
**Replies:** 1\
**Last updated:** [August 15, 2026, 8:24am UTC](https://discourse.orthanc-server.org/t/orthanc-python-plugin-that-adds-a-graphql-layer-to-reduce-rest-query-overhead/6472 "2026-08-15T08:24:13Z")

</div>

Hi Everyone, I’m happy to share that I created a new python plugin for Orthanc that extends the rest API to provide a GraphQL API. This significantly reduces the overhead of the current API, allowing one to only query t…

---

## [Move files between MultipleStorages](https://discourse.orthanc-server.org/t/move-files-between-multiplestorages/6469)

<div class="topic-metadata">

**Author:** [@daaryshev](https://discourse.orthanc-server.org/u/daaryshev)\
**Replies:** 2\
**Last updated:** [August 2, 2026, 6:29am UTC](https://discourse.orthanc-server.org/t/move-files-between-multiplestorages/6469 "2026-08-02T06:29:32Z")

</div>

Hello community, My storage for orthanc files is getting over. I would like to move old files to another storage, I am mounting smb-share for that. I created api-key via keycloak web-interface for rest-api requests, It…

---

## [Question about Peer configuration API](https://discourse.orthanc-server.org/t/question-about-peer-configuration-api/6434)

<div class="topic-metadata">

**Author:** [@shulard](https://discourse.orthanc-server.org/u/shulard)\
**Replies:** 4\
**Last updated:** [May 11, 2026, 5:05pm UTC](https://discourse.orthanc-server.org/t/question-about-peer-configuration-api/6434 "2026-05-11T17:05:38Z")

</div>

Hello ! I just found something I’m not sure about the peer configuration API. It returns the details about a Peer and that’s fine. However if I set the Username and Password when I perform a GET /peers/{id}/configurati…

---

## [Problem when restarting Orthanc via API /tools/reset](https://discourse.orthanc-server.org/t/problem-when-restarting-orthanc-via-api-tools-reset/5183)

<div class="topic-metadata">

**Author:** [@brykov93](https://discourse.orthanc-server.org/u/brykov93)\
**Replies:** 13\
**Last updated:** [April 7, 2026, 11:17am UTC](https://discourse.orthanc-server.org/t/problem-when-restarting-orthanc-via-api-tools-reset/5183 "2026-04-07T11:17:49Z")

</div>

Hi, I have an application on Django that interacts with Orthanc via the API. Sometimes it is necessary to restart Orthanc using the /tools/reset method, but the server does not rise. I get such errors in the logs at sta…

---

## [Introducing orthanc: An R package that provides a programmatic interface to Orthanc DICOM Servers](https://discourse.orthanc-server.org/t/introducing-orthanc-an-r-package-that-provides-a-programmatic-interface-to-orthanc-dicom-servers/6404)

<div class="topic-metadata">

**Author:** [@mattwrkntn](https://discourse.orthanc-server.org/u/mattwrkntn)\
**Replies:** 2\
**Last updated:** [February 20, 2026, 7:53pm UTC](https://discourse.orthanc-server.org/t/introducing-orthanc-an-r-package-that-provides-a-programmatic-interface-to-orthanc-dicom-servers/6404 "2026-02-20T19:53:41Z")

</div>

Hi, I am not sure if it is appropriate for me to share this here, but I wanted to introduce an R package I have been working on the last several weeks/months named orthanc. The package provides a programmatic interface …

---

## [Private Tag Questions](https://discourse.orthanc-server.org/t/private-tag-questions/6363)

<div class="topic-metadata">

**Author:** [@tshead](https://discourse.orthanc-server.org/u/tshead)\
**Replies:** 2\
**Last updated:** [January 8, 2026, 5:49pm UTC](https://discourse.orthanc-server.org/t/private-tag-questions/6363 "2026-01-08T17:49:05Z")

</div>

I’m using the Docker distribution of Orthanc 1.12.10 with a custom modality that contains private tags, and I see that they are registered in the dictionary at startup in the server logs. I also see that the tag names sh…

---

## [Identification of modalities for C-FIND & C-MOVE operations](https://discourse.orthanc-server.org/t/identification-of-modalities-for-c-find-c-move-operations/6311)

<div class="topic-metadata">

**Author:** [@Alberto](https://discourse.orthanc-server.org/u/Alberto)\
**Replies:** 3\
**Last updated:** [November 14, 2025, 4:25pm UTC](https://discourse.orthanc-server.org/t/identification-of-modalities-for-c-find-c-move-operations/6311 "2025-11-14T16:25:06Z")

</div>

Hi there! I’m working on a PoC using Orthanc as a proxy to an external DICOM index. I’m making use of the Python plugin, so I can override ‘OnFind’ and ‘OnMove’ handlers and implement the behavior I need. My problem i…

---

## [Orthanc endpoint /studies/{UUID}/download-as-jpeg-archive is returning 404](https://discourse.orthanc-server.org/t/orthanc-endpoint-studies-uuid-download-as-jpeg-archive-is-returning-404/6297)

<div class="topic-metadata">

**Author:** [@film33illuminator](https://discourse.orthanc-server.org/u/film33illuminator)\
**Replies:** 5\
**Last updated:** [November 1, 2025, 11:16am UTC](https://discourse.orthanc-server.org/t/orthanc-endpoint-studies-uuid-download-as-jpeg-archive-is-returning-404/6297 "2025-11-01T11:16:31Z")

</div>

Dear Orthanc Team, I’m following the guide here: For setting up Orthanc with Keycloak authentication service. The setup went well although I have to make some changes to use the VolView as will as built in OHIF. We…

---

## [Managing modalities using the REST-API and KeyCloak](https://discourse.orthanc-server.org/t/managing-modalities-using-the-rest-api-and-keycloak/6137)

<div class="topic-metadata">

**Author:** [@kenmunyao](https://discourse.orthanc-server.org/u/kenmunyao)\
**Replies:** 5\
**Last updated:** [August 28, 2025, 7:49am UTC](https://discourse.orthanc-server.org/t/managing-modalities-using-the-rest-api-and-keycloak/6137 "2025-08-28T07:49:21Z")

</div>

Hello, Amazing product first off, extremely grateful for the releases and uptades so far. I have Orthanc (version 1.12.9) with the authorization-plugin (version 0.10.1) and KeyCloak (version 26.2.5) setup and working wo…

---

## [OpenAPI specification validity](https://discourse.orthanc-server.org/t/openapi-specification-validity/6044)

<div class="topic-metadata">

**Author:** [@jennydaman](https://discourse.orthanc-server.org/u/jennydaman)\
**Replies:** 1\
**Last updated:** [August 11, 2025, 2:28pm UTC](https://discourse.orthanc-server.org/t/openapi-specification-validity/6044 "2025-08-11T14:28:42Z")

</div>

The OpenAPI schema for Orthanc 1.12.8 available from https://orthanc.uclouvain.be/api/orthanc-openapi.json is invalid: header objects must contain either schema or content schema must have type e.g. schema for applica…

---

## [Response to plugin from Orthanc API DELETE endpoint](https://discourse.orthanc-server.org/t/response-to-plugin-from-orthanc-api-delete-endpoint/6022)

<div class="topic-metadata">

**Author:** [@jennydaman](https://discourse.orthanc-server.org/u/jennydaman)\
**Replies:** 1\
**Last updated:** [July 8, 2025, 5:02pm UTC](https://discourse.orthanc-server.org/t/response-to-plugin-from-orthanc-api-delete-endpoint/6022 "2025-07-08T17:02:06Z")

</div>

I am trying to develop an Orthanc plugin against Orthanc version 1.12.8. I notice that, when deleting an instance, series, or study, the API returns to an HTTP client some JSON indicating the deleted resources’ “Remaini…

---

## [/tools/find MetadataQuery](https://discourse.orthanc-server.org/t/tools-find-metadataquery/5617)

<div class="topic-metadata">

**Author:** [@nil](https://discourse.orthanc-server.org/u/nil)\
**Replies:** 10\
**Last updated:** [May 16, 2025, 2:08pm UTC](https://discourse.orthanc-server.org/t/tools-find-metadataquery/5617 "2025-05-16T14:08:04Z")

</div>

Hi. I need to get the “latest” studies. LastUpdate looks like a good choice for this task. I saw the MetadataQuery parameter on /tools/find, but when I try to use it -d '{"Level": "Study", "MetadataQuery": {"LastUpdate"…

---

## [Changelist reporting series before series is fully received](https://discourse.orthanc-server.org/t/changelist-reporting-series-before-series-is-fully-received/5801)

<div class="topic-metadata">

**Author:** [@blacava](https://discourse.orthanc-server.org/u/blacava)\
**Replies:** 2\
**Last updated:** [May 7, 2025, 2:00pm UTC](https://discourse.orthanc-server.org/t/changelist-reporting-series-before-series-is-fully-received/5801 "2025-05-07T14:00:11Z")

</div>

Hi. We are using the REST API to track changes on the Orthanc 1.12.1 server. When sending a CT to Orthanc, a new series is reported in the changelist before all the slice instances have arrived. What we would really like…

---

## [Tools/find for floats array, or bulk tags](https://discourse.orthanc-server.org/t/tools-find-for-floats-array-or-bulk-tags/5809)

<div class="topic-metadata">

**Author:** [@nil](https://discourse.orthanc-server.org/u/nil)\
**Replies:** 2\
**Last updated:** [May 5, 2025, 2:03pm UTC](https://discourse.orthanc-server.org/t/tools-find-for-floats-array-or-bulk-tags/5809 "2025-05-05T14:03:46Z")

</div>

I’m trying to find all instances of a series with a specific ImagePositionPatient. For example, when I ask the API, Orthanc tells me that one of the instance has "ImagePositionPatient" : "93.81687\\\\-137.8313\\\\93.72376"…

---

## [Issue with uploading scans to orthanc](https://discourse.orthanc-server.org/t/issue-with-uploading-scans-to-orthanc/5797)

<div class="topic-metadata">

**Author:** [@adhithya](https://discourse.orthanc-server.org/u/adhithya)\
**Replies:** 2\
**Last updated:** [April 30, 2025, 3:44am UTC](https://discourse.orthanc-server.org/t/issue-with-uploading-scans-to-orthanc/5797 "2025-04-30T03:44:05Z")

</div>

Greeting everyone, We are running 3 Orthanc instances through Kubernetes and the docker image used is orthancteam/orthanc:25.2.0. All 3 orthanc share the same Postgres database and the same scan storage path. We use one…

---

## [Sending images to DICOM TLS Server: TLS error: bad extention](https://discourse.orthanc-server.org/t/sending-images-to-dicom-tls-server-tls-error-bad-extention/5795)

<div class="topic-metadata">

**Author:** [@ericksagis](https://discourse.orthanc-server.org/u/ericksagis)\
**Replies:** 1\
**Last updated:** [April 29, 2025, 9:17am UTC](https://discourse.orthanc-server.org/t/sending-images-to-dicom-tls-server-tls-error-bad-extention/5795 "2025-04-29T09:17:35Z")

</div>

Hi, I’am trying to send a Dicom image/pasient from my Orthanc server to a DicomServer with TLS. The error message i get is: “Details”: “DicomAssociation - connecting to AET “MY\_AET”: TLS error: bad extention”. what can b…

---

## [Issue/typo with openapi C-GET specification?](https://discourse.orthanc-server.org/t/issue-typo-with-openapi-c-get-specification/5641)

<div class="topic-metadata">

**Author:** [@gacou54](https://discourse.orthanc-server.org/u/gacou54)\
**Replies:** 2\
**Last updated:** [March 20, 2025, 6:01pm UTC](https://discourse.orthanc-server.org/t/issue-typo-with-openapi-c-get-specification/5641 "2025-03-20T18:01:23Z")

</div>

Bonjour, I was implementing the new C-GET feature in PyOrthanc and was wondering if there was an error in the openapi documentation (Orthanc REST API). I was able to get the endpoint working with a request body that co…

---

## [LastUpdate coherency](https://discourse.orthanc-server.org/t/lastupdate-coherency/5524)

<div class="topic-metadata">

**Author:** [@nil](https://discourse.orthanc-server.org/u/nil)\
**Replies:** 2\
**Last updated:** [February 13, 2025, 2:12pm UTC](https://discourse.orthanc-server.org/t/lastupdate-coherency/5524 "2025-02-13T14:12:30Z")

</div>

Hi. I just realized that the output from /studies/{id} /series/{id}/study is not exactly the same. In fact, all fields are identical :+1: but there’s a missing field when using /series/{id}/study, namely LastUpdate. I…

---

## [Exporting Cine Loops as MP4 Videos from Orthanc (API)](https://discourse.orthanc-server.org/t/exporting-cine-loops-as-mp4-videos-from-orthanc-api/5388)

<div class="topic-metadata">

**Author:** [@kylebolt](https://discourse.orthanc-server.org/u/kylebolt)\
**Replies:** 3\
**Last updated:** [December 3, 2024, 7:15am UTC](https://discourse.orthanc-server.org/t/exporting-cine-loops-as-mp4-videos-from-orthanc-api/5388 "2024-12-03T07:15:25Z")

</div>

Hello Orthanc Community, I’m building a service to export dicom videos or cine loops from Orthanc as MP4 videos. Would this be the best approach, where I export the frames of the video and then reassemble them into a v…

---

## [Orthanc on Ubuntu, Can't run Python Scripts](https://discourse.orthanc-server.org/t/orthanc-on-ubuntu-cant-run-python-scripts/5357)

<div class="topic-metadata">

**Author:** [@kabary](https://discourse.orthanc-server.org/u/kabary)\
**Replies:** 4\
**Last updated:** [November 26, 2024, 4:35am UTC](https://discourse.orthanc-server.org/t/orthanc-on-ubuntu-cant-run-python-scripts/5357 "2024-11-26T04:35:34Z")

</div>

Good day everyone, hope you are doing very well. I have installed Orthanc on Ubuntu by following the documentation here: https://orthanc.uclouvain.be/book/users/debian-packages.html And it starts beautifully. However…

---

## [Orthanc tools/find API: Is there any limit on the length of the query value?](https://discourse.orthanc-server.org/t/orthanc-tools-find-api-is-there-any-limit-on-the-length-of-the-query-value/5129)

<div class="topic-metadata">

**Author:** [@william.choy.pmt](https://discourse.orthanc-server.org/u/william.choy.pmt)\
**Replies:** 6\
**Last updated:** [November 11, 2024, 6:42am UTC](https://discourse.orthanc-server.org/t/orthanc-tools-find-api-is-there-any-limit-on-the-length-of-the-query-value/5129 "2024-11-11T06:42:55Z")

</div>

The following is the json I tried to POST to toots/find API. For the SOPInstanceUID key in Query, i want to specify hundreds or even thousands values of SOPInstanceUID. But, i got “Internal Server Error” as response. So,…

---

## [Webhooks & Delete Api Cors issue](https://discourse.orthanc-server.org/t/webhooks-delete-api-cors-issue/5264)

<div class="topic-metadata">

**Author:** [@Viniith](https://discourse.orthanc-server.org/u/Viniith)\
**Replies:** 2\
**Last updated:** [October 28, 2024, 9:44pm UTC](https://discourse.orthanc-server.org/t/webhooks-delete-api-cors-issue/5264 "2024-10-28T21:44:44Z")

</div>

Does Orthanc support WebSockets or Webhooks? Also Additionally, I am encountering a CORS issue when trying to access the DELETE API in a production environment. I have already defined DELETE along with other methods su…

---

## [Real Time Notifications](https://discourse.orthanc-server.org/t/real-time-notifications/5276)

<div class="topic-metadata">

**Author:** [@Viniith](https://discourse.orthanc-server.org/u/Viniith)\
**Replies:** 3\
**Last updated:** [October 27, 2024, 1:16am UTC](https://discourse.orthanc-server.org/t/real-time-notifications/5276 "2024-10-27T01:16:54Z")

</div>

I want to notify my backend server whenever a new study is uploaded to the Orthanc server. I don’t want to use polling, as it would continuously fetch data from the Orthanc server and slow down the system. Instead, I wou…

---

## [Problem with Lookup tools](https://discourse.orthanc-server.org/t/problem-with-lookup-tools/5232)

<div class="topic-metadata">

**Author:** [@hamiltonxb3.2](https://discourse.orthanc-server.org/u/hamiltonxb3.2)\
**Replies:** 1\
**Last updated:** [October 9, 2024, 9:44am UTC](https://discourse.orthanc-server.org/t/problem-with-lookup-tools/5232 "2024-10-09T09:44:37Z")

</div>

Hello everyone, I’m currently experiencing issues with the Orthanc server, specifically regarding the lookup service and accessing certain DICOM items. the query studies/{StudiesId} gave a response with the Study D…

---

## [Updating DICOM metadata via API](https://discourse.orthanc-server.org/t/updating-dicom-metadata-via-api/5170)

<div class="topic-metadata">

**Author:** [@wtellis](https://discourse.orthanc-server.org/u/wtellis)\
**Replies:** 3\
**Last updated:** [September 20, 2024, 6:24am UTC](https://discourse.orthanc-server.org/t/updating-dicom-metadata-via-api/5170 "2024-09-20T06:24:42Z")

</div>

Hi, It is possible to update the DICOM metadata of an existing study using the API. For example if we have a study that’s stored with acc # ABCD and we’d like to change it to WXYZ, is that possible via the API or updat…

---

## [RestApiGet and LUA Scripting in Orthanc](https://discourse.orthanc-server.org/t/restapiget-and-lua-scripting-in-orthanc/5132)

<div class="topic-metadata">

**Author:** [@Khaled](https://discourse.orthanc-server.org/u/Khaled)\
**Replies:** 2\
**Last updated:** [September 1, 2024, 8:17pm UTC](https://discourse.orthanc-server.org/t/restapiget-and-lua-scripting-in-orthanc/5132 "2024-09-01T20:17:04Z")

</div>

Hello everyone, I’m working on a LUA script that utilizes RestApiGet(uri) to retrieve data from a Postgres database, which is accessed via an API hosted on another container on the same server. I am able to successfull…

---

## [Confusion regarding priority argument](https://discourse.orthanc-server.org/t/confusion-regarding-priority-argument/5099)

<div class="topic-metadata">

**Author:** [@jmrivera](https://discourse.orthanc-server.org/u/jmrivera)\
**Replies:** 1\
**Last updated:** [August 26, 2024, 1:38pm UTC](https://discourse.orthanc-server.org/t/confusion-regarding-priority-argument/5099 "2024-08-26T13:38:34Z")

</div>

Hello to everyone, I want to priorize a job using the “priority” argument in a HTTP request. In the reference API it says “the lower the value, the higher the priority”, but in the orthanc book it states that it “picks …

---

## [Searching for labels](https://discourse.orthanc-server.org/t/searching-for-labels/5116)

<div class="topic-metadata">

**Author:** [@rubenv](https://discourse.orthanc-server.org/u/rubenv)\
**Replies:** 2\
**Last updated:** [August 23, 2024, 2:42pm UTC](https://discourse.orthanc-server.org/t/searching-for-labels/5116 "2024-08-23T14:42:30Z")

</div>

Greetings! I’m having some trouble making the /tools/find endpoint behave as I expect it to. First of all, I have uploaded some sample data into Orthanc. To the study I have attached a label, as shown here: # curl -u …

---

## [Fetching dicoms with dicomweb-client package and Nginx reverse proxy on orthanc](https://discourse.orthanc-server.org/t/fetching-dicoms-with-dicomweb-client-package-and-nginx-reverse-proxy-on-orthanc/4978)

<div class="topic-metadata">

**Author:** [@Dr-muwa](https://discourse.orthanc-server.org/u/Dr-muwa)\
**Replies:** 1\
**Last updated:** [August 16, 2024, 9:06am UTC](https://discourse.orthanc-server.org/t/fetching-dicoms-with-dicomweb-client-package-and-nginx-reverse-proxy-on-orthanc/4978 "2024-08-16T09:06:09Z")

</div>

This is my nginx configuration: \`server { listen 80; server\_name localhost; #charset koi8-r; access\_log logs/host.access.log main; # location / { # root html; # index index.ht…

[Next page](https://discourse.orthanc-server.org/tag/rest-api/1.md?match_all_tags=true&page=1&tags%5B%5D=rest-api)