Orthanc Server

Orthanc API

This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc. This reference is automatically generated from…

Developer tools#openapi#collaboration

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the full documentation of the REST API of Orthanc. This reference is automatically generated from the source code of Orthanc. A shorter cheat sheet is part of the Orthanc Book. An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore (source).

Endpoints 274

Tracking changes

  • GETList changes/changes?limit=0.0&since=0.0Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called _Changes Log_. This enables remote scripts to react to the arrival of…
  • DELETEClear changes/changesClear the full history stored in the changes log
  • GETList exports/exports?limit=0.0&since=0.0For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing…
  • DELETEClear exports/exportsClear the full history stored in the exports log

Instances

  • GETList the available instances/instances?expand=string&full=true&limit=0.0&requestedTags=string&short=true&since=0.0List the Orthanc identifiers of all the available DICOM instances
  • POSTUpload DICOM instances/instancesUpload DICOM instances
  • GETGet information about some instance/instances/:id?full=true&requestedTags=string&short=trueGet detailed information about the DICOM instance whose Orthanc identifier is provided in the URL
  • DELETEDelete some instance/instances/:idDelete the DICOM instance whose Orthanc identifier is provided in the URL
  • POSTAnonymize instance/instances/:id/anonymizeDownload an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL:…
  • GETList attachments/instances/:id/attachments?full=stringGet the list of attachments that are associated with the given instance
  • PUTSet attachment/instances/:id/attachments/:nameAttach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
  • DELETEDelete attachment/instances/:id/attachments/:nameDelete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
  • POSTCompress attachment/instances/:id/attachments/:name/compressChange the compression scheme that is used to store an attachment.
  • GETGet attachment (no decompression)/instances/:id/attachments/:name/compressed-dataGet the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if StorageCompression is true.
  • GETGet MD5 of attachment on disk/instances/:id/attachments/:name/compressed-md5Get the MD5 hash of one attachment associated with the given instance, as stored on the disk. This is different from .../md5 iff EnableStorage is true.
  • GETGet size of attachment on disk/instances/:id/attachments/:name/compressed-sizeGet the size of one attachment associated with the given instance, as stored on the disk. This is different from .../size iff EnableStorage is true.
  • GETGet attachment/instances/:id/attachments/:name/dataGet the (binary) content of one attachment associated with the given instance
  • GETGet info about the attachment/instances/:id/attachments/:name/infoGet all the information about the attachment associated with the given instance
  • GETIs attachment compressed?/instances/:id/attachments/:name/is-compressedTest whether the attachment has been stored as a compressed file on the disk.
  • GETGet MD5 of attachment/instances/:id/attachments/:name/md5Get the MD5 hash of one attachment associated with the given instance
  • GETGet size of attachment/instances/:id/attachments/:name/sizeGet the size of one attachment associated with the given instance
  • POSTUncompress attachment/instances/:id/attachments/:name/uncompressChange the compression scheme that is used to store an attachment.
  • POSTVerify attachment/instances/:id/attachments/:name/verify-md5Verify that the attachment is not corrupted, by validating its MD5 hash
  • GETGet raw tag/instances/:id/content?...=stringGet the raw content of one DICOM tag in the hierarchy of DICOM dataset
  • POSTWrite DICOM onto filesystem/instances/:id/exportWrite the DICOM file onto the filesystem where Orthanc is running
  • GETDownload DICOM/instances/:id/fileDownload one DICOM instance
  • GETList available frames/instances/:id/framesList the frames that are available in the DICOM instance of interest
  • GETDecode a frame (int16)/instances/:id/frames/:frame/image-int16?quality=0.0&returnUnsupportedImage=trueDecode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be…
  • GETDecode a frame (uint16)/instances/:id/frames/:frame/image-uint16?quality=0.0&returnUnsupportedImage=trueDecode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
  • GETDecode a frame (uint8)/instances/:id/frames/:frame/image-uint8?quality=0.0&returnUnsupportedImage=trueDecode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
  • GETDecode frame for Matlab/instances/:id/frames/:frame/matlabDecode one frame of interest from the given DICOM instance, and export this frame as a Octave/Matlab matrix to be imported with eval():…
  • GETDecode frame for numpy/instances/:id/frames/:frame/numpy?compress=true&rescale=trueDecode one frame of interest from the given DICOM instance, for use with numpy in Python. The numpy array has 3 dimensions: (height, width, color channel).
  • GETDecode a frame (preview)/instances/:id/frames/:frame/preview?quality=0.0&returnUnsupportedImage=trueDecode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
  • GETAccess raw frame/instances/:id/frames/:frame/rawAccess the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files…
  • GETAccess raw frame (compressed)/instances/:id/frames/:frame/raw.gzAccess the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files…
  • GETRender a frame/instances/:id/frames/:frame/rendered?height=0.0&quality=0.0&returnUnsupportedImage=true&smooth=true&width=0.0&window-center=0.0&window-width=0.0Render one frame of interest from the given DICOM instance. This function takes scaling into account (RescaleSlope and RescaleIntercept tags), as well as the…
  • GETGet DICOM meta-header/instances/:id/header?short=true&simplify=trueGet the DICOM tags in the meta-header of the DICOM instance. By default, the full format is used, which combines hexadecimal tags with human-readable…
  • GETDecode an image (int16)/instances/:id/image-int16?quality=0.0&returnUnsupportedImage=trueDecode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted…
  • GETDecode an image (uint16)/instances/:id/image-uint16?quality=0.0&returnUnsupportedImage=trueDecode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
  • GETDecode an image (uint8)/instances/:id/image-uint8?quality=0.0&returnUnsupportedImage=trueDecode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
  • GETDecode frame for Matlab/instances/:id/matlabDecode the first frame of the given DICOM instance., and export this frame as a Octave/Matlab matrix to be imported with eval():…
  • GETList metadata/instances/:id/metadata?expand=stringGet the list of metadata that are associated with the given instance
  • GETGet metadata/instances/:id/metadata/:nameGet the value of a metadata that is associated with the given instance
  • PUTSet metadata/instances/:id/metadata/:nameSet the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
  • DELETEDelete metadata/instances/:id/metadata/:nameDelete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
  • POSTModify instance/instances/:id/modifyDownload a modified version of the DICOM instance whose Orthanc identifier is provided in the URL:…
  • GETGet instance module/instances/:id/module?ignore-length=string&short=true&simplify=trueGet the instance module of the DICOM instance whose Orthanc identifier is provided in the URL
  • GETDecode instance for numpy/instances/:id/numpy?compress=true&rescale=trueDecode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
  • GETGet parent patient/instances/:id/patient?full=true&requestedTags=string&short=trueGet detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL
  • GETGet embedded PDF/instances/:id/pdfGet the PDF file that is embedded in one DICOM instance. If the DICOM instance doesn't contain the EncapsulatedDocument tag or if the…
  • GETDecode an image (preview)/instances/:id/preview?quality=0.0&returnUnsupportedImage=trueDecode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
  • POSTReconstruct tags & optionally files of instance/instances/:id/reconstructReconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have…
  • GETRender an image/instances/:id/rendered?height=0.0&quality=0.0&returnUnsupportedImage=true&smooth=true&width=0.0&window-center=0.0&window-width=0.0Render the first frame of the given DICOM instance. This function takes scaling into account (RescaleSlope and RescaleIntercept tags), as well as the default…
  • GETGet parent series/instances/:id/series?full=true&requestedTags=string&short=trueGet detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL
  • GETGet human-readable tags/instances/:id/simplified-tags?ignore-length=stringGet the DICOM tags in human-readable format (same as the /instances/{id}/tags?simplify route)
  • GETGet instance statistics/instances/:id/statisticsGet statistics about the given instance
  • GETGet parent study/instances/:id/study?full=true&requestedTags=string&short=trueGet detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL
  • GETGet DICOM tags/instances/:id/tags?ignore-length=string&short=true&simplify=trueGet the DICOM tags in the specified format. By default, the full format is used, which combines hexadecimal tags with human-readable description.

Other

  • GETList operations on attachments/instances/:id/attachments/:nameGet the list of the operations that are available for attachments associated with the given instance
  • GETList operations/instances/:id/frames/:frameList the available operations under URI /instances/{id}/frames/{frame}/
  • GETList operations on attachments/patients/:id/attachments/:nameGet the list of the operations that are available for attachments associated with the given patient
  • GETList operations on attachments/series/:id/attachments/:nameGet the list of the operations that are available for attachments associated with the given series
  • GETList operations on attachments/studies/:id/attachments/:nameGet the list of the operations that are available for attachments associated with the given study
  • GETList operations/toolsList the available operations under URI /tools/

Jobs

  • GETList jobs/jobs?expand=stringList all the available jobs
  • GETGet job/jobs/:idRetrieve detailed information about the job whose identifier is provided in the URL: https://book.orthanc-server.com/users/advanced-rest.html#jobs
  • POSTCancel job/jobs/:id/cancelCancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs:…
  • POSTPause job/jobs/:id/pausePause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs:…
  • POSTResubmit job/jobs/:id/resubmitResubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs:…
  • POSTResume job/jobs/:id/resumeResume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs:…
  • GETGet job output/jobs/:id/:keyRetrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with key…

Networking

  • GETList DICOM modalities/modalities?expand=stringList all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the DicomModalities configuration option, or to the…
  • GETList operations on modality/modalities/:idList the operations that are available for a DICOM modality.
  • PUTUpdate DICOM modality/modalities/:idDefine a new DICOM modality, or update an existing one. This change is permanent iff. DicomModalitiesInDatabase is true, otherwise it is lost at the next…
  • DELETEDelete DICOM modality/modalities/:idDelete one DICOM modality. This change is permanent iff. DicomModalitiesInDatabase is true, otherwise it is lost at the next restart of Orthanc.
  • GETGet modality configuration/modalities/:id/configurationGet detailed information about the configuration of some DICOM modality
  • POSTTrigger C-ECHO SCU/modalities/:id/echoTrigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-c-echo
  • POSTHierarchical C-FIND SCU/modalities/:id/findDeprecated. Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of…
  • POSTC-FIND SCU for instances/modalities/:id/find-instanceDeprecated. Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of…
  • POSTC-FIND SCU for patients/modalities/:id/find-patientDeprecated. Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of…
  • POSTC-FIND SCU for series/modalities/:id/find-seriesDeprecated. Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of…
  • POSTC-FIND SCU for studies/modalities/:id/find-studyDeprecated. Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of…
  • POSTC-FIND SCU for worklist/modalities/:id/find-worklistTrigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL
  • POSTTrigger C-MOVE SCU/modalities/:id/moveStart a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is…
  • POSTTrigger C-FIND SCU/modalities/:id/queryTrigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL:…
  • POSTTrigger storage commitment request/modalities/:id/storage-commitmentTrigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL:…
  • POSTTrigger C-STORE SCU/modalities/:id/storeStart a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL:…
  • POSTStraight C-STORE SCU/modalities/:id/store-straightSynchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it…
  • GETList Orthanc peers/peers?expand=stringList all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the OrthancPeers configuration option, or to the information…
  • GETList operations on peer/peers/:idList the operations that are available for an Orthanc peer.
  • PUTUpdate Orthanc peer/peers/:idDefine a new Orthanc peer, or update an existing one. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart…
  • DELETEDelete Orthanc peer/peers/:idDelete one Orthanc peer. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart of Orthanc.
  • GETGet peer configuration/peers/:id/configurationGet detailed information about the configuration of some Orthanc peer
  • POSTSend to Orthanc peer/peers/:id/storeSend DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL:…
  • POSTStraight store to peer/peers/:id/store-straightSynchronously send the DICOM instance in the POST body to the Orthanc peer whose identifier is provided in URL, without having to first store it locally…
  • GETGet peer system information/peers/:id/systemGet system information about some Orthanc peer. This corresponds to doing a GET request against the /system URI of the remote peer. This route can be used to…
  • GETList query/retrieve operations/queriesList the identifiers of all the query/retrieve operations on DICOM modalities, as initiated by calls to /modalities/{id}/query. The length of this list is…
  • GETList operations on a query/queries/:idList the available operations for the query/retrieve operation whose identifier is provided in the URL
  • DELETEDelete a query/queries/:idDelete the query/retrieve operation whose identifier is provided in the URL
  • GETList answers to a query/queries/:id/answers?expand=string&short=true&simplify=trueList the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL
  • GETList operations on an answer/queries/:id/answers/:indexList the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL
  • GETGet one answer/queries/:id/answers/:index/content?short=true&simplify=trueGet the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL
  • POSTQuery the child instances of an answer/queries/:id/answers/:index/query-instancesIssue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are…
  • POSTQuery the child series of an answer/queries/:id/answers/:index/query-seriesIssue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are…
  • POSTQuery the child studies of an answer/queries/:id/answers/:index/query-studiesIssue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are…
  • POSTRetrieve one answer/queries/:id/answers/:index/retrieveStart a C-MOVE SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL:…
  • GETGet level of original query/queries/:id/levelGet the query level (value of the QueryRetrieveLevel tag) of the query/retrieve operation whose identifier is provided in the URL
  • GETGet modality of original query/queries/:id/modalityGet the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL
  • GETGet original query arguments/queries/:id/query?short=true&simplify=trueGet the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL
  • POSTRetrieve all answers/queries/:id/retrieveStart a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the…
  • GETGet storage commitment report/storage-commitment/:idGet the storage commitment report whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu
  • POSTRemove after storage commitment/storage-commitment/:id/removeRemove out of Orthanc, the DICOM instances that have been reported to have been properly received the storage commitment report whose identifier is provided…

Patients

  • GETList the available patients/patients?expand=string&full=true&limit=0.0&requestedTags=string&short=true&since=0.0List the Orthanc identifiers of all the available DICOM patients
  • GETGet information about some patient/patients/:id?full=true&requestedTags=string&short=trueGet detailed information about the DICOM patient whose Orthanc identifier is provided in the URL
  • DELETEDelete some patient/patients/:idDelete the DICOM patient whose Orthanc identifier is provided in the URL
  • POSTAnonymize patient/patients/:id/anonymizeStart a job that will anonymize all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be…
  • GETCreate ZIP archive/patients/:id/archive?filename=string&transcode=stringSynchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not*…
  • POSTCreate ZIP archive/patients/:id/archiveCreate a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL
  • GETList attachments/patients/:id/attachments?full=stringGet the list of attachments that are associated with the given patient
  • PUTSet attachment/patients/:id/attachments/:nameAttach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
  • DELETEDelete attachment/patients/:id/attachments/:nameDelete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
  • POSTCompress attachment/patients/:id/attachments/:name/compressChange the compression scheme that is used to store an attachment.
  • GETGet attachment (no decompression)/patients/:id/attachments/:name/compressed-dataGet the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if StorageCompression is true.
  • GETGet MD5 of attachment on disk/patients/:id/attachments/:name/compressed-md5Get the MD5 hash of one attachment associated with the given patient, as stored on the disk. This is different from .../md5 iff EnableStorage is true.
  • GETGet size of attachment on disk/patients/:id/attachments/:name/compressed-sizeGet the size of one attachment associated with the given patient, as stored on the disk. This is different from .../size iff EnableStorage is true.
  • GETGet attachment/patients/:id/attachments/:name/dataGet the (binary) content of one attachment associated with the given patient
  • GETGet info about the attachment/patients/:id/attachments/:name/infoGet all the information about the attachment associated with the given patient
  • GETIs attachment compressed?/patients/:id/attachments/:name/is-compressedTest whether the attachment has been stored as a compressed file on the disk.
  • GETGet MD5 of attachment/patients/:id/attachments/:name/md5Get the MD5 hash of one attachment associated with the given patient
  • GETGet size of attachment/patients/:id/attachments/:name/sizeGet the size of one attachment associated with the given patient
  • POSTUncompress attachment/patients/:id/attachments/:name/uncompressChange the compression scheme that is used to store an attachment.
  • POSTVerify attachment/patients/:id/attachments/:name/verify-md5Verify that the attachment is not corrupted, by validating its MD5 hash
  • GETGet child instances/patients/:id/instances?full=true&requestedTags=string&short=trueGet detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
  • GETGet tags of instances/patients/:id/instances-tags?ignore-length=string&short=true&simplify=trueGet the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
  • GETCreate DICOMDIR media/patients/:id/media?extended=string&filename=string&transcode=stringSynchronously create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might…
  • POSTCreate DICOMDIR media/patients/:id/mediaCreate a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL
  • GETList metadata/patients/:id/metadata?expand=stringGet the list of metadata that are associated with the given patient
  • GETGet metadata/patients/:id/metadata/:nameGet the value of a metadata that is associated with the given patient
  • PUTSet metadata/patients/:id/metadata/:nameSet the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
  • DELETEDelete metadata/patients/:id/metadata/:nameDelete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
  • POSTModify patient/patients/:id/modifyStart a job that will modify all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored…
  • GETGet patient module/patients/:id/module?ignore-length=string&short=true&simplify=trueGet the patient module of the DICOM patient whose Orthanc identifier is provided in the URL
  • GETIs the patient protected against recycling?/patients/:id/protectedIs the patient protected against recycling?
  • PUTProtect one patient against recycling/patients/:id/protectedCheck out configuration options MaximumStorageSize and MaximumPatientCount
  • POSTReconstruct tags & optionally files of patient/patients/:id/reconstructReconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have…
  • GETGet child series/patients/:id/series?full=true&requestedTags=string&short=trueGet detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL
  • GETGet shared tags/patients/:id/shared-tags?short=true&simplify=trueExtract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
  • GETGet patient statistics/patients/:id/statisticsGet statistics about the given patient
  • GETGet child studies/patients/:id/studies?full=true&requestedTags=string&short=trueGet detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL

System

  • GETList plugins/pluginsList all the installed plugins
  • GETJavaScript extensions to Orthanc Explorer/plugins/explorer.jsGet the JavaScript extensions that are installed by all the plugins using the OrthancPluginExtendOrthancExplorer() function of the plugin SDK. This route is…
  • GETGet plugin/plugins/:idGet system information about the plugin whose identifier is provided in the URL
  • GETGet database statistics/statisticsGet statistics related to the database of Orthanc
  • GETGet system information/systemGet system information about Orthanc
  • GETGet accepted transfer syntaxes/tools/accepted-transfer-syntaxesGet the list of UIDs of the DICOM transfer syntaxes that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options…
  • PUTSet accepted transfer syntaxes/tools/accepted-transfer-syntaxesSet the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP
  • POSTAnonymize a set of resources/tools/bulk-anonymizeStart a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.
  • POSTDescribe a set of resources/tools/bulk-contentGet the content all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field, in one single call.
  • POSTDelete a set of resources/tools/bulk-deleteDelete all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.
  • POSTModify a set of resources/tools/bulk-modifyStart a job that will modify all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.
  • POSTCreate ZIP archive/tools/create-archiveCreate a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
  • POSTCreate one DICOM instance/tools/create-dicomCreate one DICOM instance, and store it into Orthanc
  • POSTCreate DICOMDIR media/tools/create-mediaCreate a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
  • POSTCreate DICOMDIR media/tools/create-media-extendedCreate a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
  • GETGet default encoding/tools/default-encodingGet the default encoding that is used by Orthanc if parsing a DICOM instance without the SpecificCharacterEncoding tag, or during C-FIND. This corresponds to…
  • PUTSet default encoding/tools/default-encodingChange the default encoding that is used by Orthanc if parsing a DICOM instance without the SpecificCharacterEncoding tag, or during C-FIND. This corresponds…
  • GETGet DICOM conformance/tools/dicom-conformanceGet the DICOM conformance statement of Orthanc
  • POSTTrigger C-ECHO SCU/tools/dicom-echoTrigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some /modalities/{id} (new in…
  • POSTExecute Lua script/tools/execute-scriptExecute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible, cf. configuration option…
  • POSTLook for local resources/tools/findThis URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND…
  • GETGenerate an identifier/tools/generate-uid?level=stringGenerate a random DICOM identifier
  • POSTInvalidate DICOM-as-JSON summaries/tools/invalidate-tagsRemove all the attachments of the type "DICOM-as-JSON" that are associated will all the DICOM instances stored in Orthanc. These summaries will be…
  • POSTLook for DICOM identifiers/tools/lookupThis URI can be used to convert one DICOM identifier to a list of matching Orthanc resources
  • GETAre metrics collected?/tools/metricsReturns a Boolean specifying whether Prometheus metrics are collected and exposed at /tools/metrics-prometheus
  • PUTEnable collection of metrics/tools/metricsEnable or disable the collection and publication of metrics at /tools/metrics-prometheus
  • GETGet usage metrics/tools/metrics-prometheusGet usage metrics of Orthanc in the Prometheus file format (OpenMetrics):…
  • GETGet UTC time/tools/nowGet UTC time
  • GETGet local time/tools/now-localGet local time
  • POSTReconstruct all the index/tools/reconstructReconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose…
  • POSTRestart Orthanc/tools/resetRestart Orthanc
  • POSTShutdown Orthanc/tools/shutdownShutdown Orthanc
  • GETIs unknown SOP class accepted?/tools/unknown-sop-class-acceptedShall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?
  • PUTSet unknown SOP class accepted/tools/unknown-sop-class-acceptedSet whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID

Series

  • GETList the available series/series?expand=string&full=true&limit=0.0&requestedTags=string&short=true&since=0.0List the Orthanc identifiers of all the available DICOM series
  • GETGet information about some series/series/:id?full=true&requestedTags=string&short=trueGet detailed information about the DICOM series whose Orthanc identifier is provided in the URL
  • DELETEDelete some series/series/:idDelete the DICOM series whose Orthanc identifier is provided in the URL
  • POSTAnonymize series/series/:id/anonymizeStart a job that will anonymize all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored…
  • GETCreate ZIP archive/series/:id/archive?filename=string&transcode=stringSynchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not*…
  • POSTCreate ZIP archive/series/:id/archiveCreate a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL
  • GETList attachments/series/:id/attachments?full=stringGet the list of attachments that are associated with the given series
  • PUTSet attachment/series/:id/attachments/:nameAttach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
  • DELETEDelete attachment/series/:id/attachments/:nameDelete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
  • POSTCompress attachment/series/:id/attachments/:name/compressChange the compression scheme that is used to store an attachment.
  • GETGet attachment (no decompression)/series/:id/attachments/:name/compressed-dataGet the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if StorageCompression is true.
  • GETGet MD5 of attachment on disk/series/:id/attachments/:name/compressed-md5Get the MD5 hash of one attachment associated with the given series, as stored on the disk. This is different from .../md5 iff EnableStorage is true.
  • GETGet size of attachment on disk/series/:id/attachments/:name/compressed-sizeGet the size of one attachment associated with the given series, as stored on the disk. This is different from .../size iff EnableStorage is true.
  • GETGet attachment/series/:id/attachments/:name/dataGet the (binary) content of one attachment associated with the given series
  • GETGet info about the attachment/series/:id/attachments/:name/infoGet all the information about the attachment associated with the given series
  • GETIs attachment compressed?/series/:id/attachments/:name/is-compressedTest whether the attachment has been stored as a compressed file on the disk.
  • GETGet MD5 of attachment/series/:id/attachments/:name/md5Get the MD5 hash of one attachment associated with the given series
  • GETGet size of attachment/series/:id/attachments/:name/sizeGet the size of one attachment associated with the given series
  • POSTUncompress attachment/series/:id/attachments/:name/uncompressChange the compression scheme that is used to store an attachment.
  • POSTVerify attachment/series/:id/attachments/:name/verify-md5Verify that the attachment is not corrupted, by validating its MD5 hash
  • GETGet child instances/series/:id/instances?full=true&requestedTags=string&short=trueGet detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL
  • GETGet tags of instances/series/:id/instances-tags?ignore-length=string&short=true&simplify=trueGet the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
  • GETCreate DICOMDIR media/series/:id/media?extended=string&filename=string&transcode=stringSynchronously create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might…
  • POSTCreate DICOMDIR media/series/:id/mediaCreate a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL
  • GETList metadata/series/:id/metadata?expand=stringGet the list of metadata that are associated with the given series
  • GETGet metadata/series/:id/metadata/:nameGet the value of a metadata that is associated with the given series
  • PUTSet metadata/series/:id/metadata/:nameSet the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
  • DELETEDelete metadata/series/:id/metadata/:nameDelete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
  • POSTModify series/series/:id/modifyStart a job that will modify all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored…
  • GETGet series module/series/:id/module?ignore-length=string&short=true&simplify=trueGet the series module of the DICOM series whose Orthanc identifier is provided in the URL
  • GETDecode series for numpy/series/:id/numpy?compress=true&rescale=trueDecode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
  • GETOrder the slices/series/:id/ordered-slicesDeprecated. Sort the instances and frames (slices) of the DICOM series whose Orthanc identifier is provided in the URL. This URI is essentially used by the…
  • GETGet parent patient/series/:id/patient?full=true&requestedTags=string&short=trueGet detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL
  • POSTReconstruct tags & optionally files of series/series/:id/reconstructReconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have…
  • GETGet shared tags/series/:id/shared-tags?short=true&simplify=trueExtract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
  • GETGet series statistics/series/:id/statisticsGet statistics about the given series
  • GETGet parent study/series/:id/study?full=true&requestedTags=string&short=trueGet detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL

Studies

  • GETList the available studies/studies?expand=string&full=true&limit=0.0&requestedTags=string&short=true&since=0.0List the Orthanc identifiers of all the available DICOM studies
  • GETGet information about some study/studies/:id?full=true&requestedTags=string&short=trueGet detailed information about the DICOM study whose Orthanc identifier is provided in the URL
  • DELETEDelete some study/studies/:idDelete the DICOM study whose Orthanc identifier is provided in the URL
  • POSTAnonymize study/studies/:id/anonymizeStart a job that will anonymize all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored…
  • GETCreate ZIP archive/studies/:id/archive?filename=string&transcode=stringSynchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not*…
  • POSTCreate ZIP archive/studies/:id/archiveCreate a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL
  • GETList attachments/studies/:id/attachments?full=stringGet the list of attachments that are associated with the given study
  • PUTSet attachment/studies/:id/attachments/:nameAttach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
  • DELETEDelete attachment/studies/:id/attachments/:nameDelete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
  • POSTCompress attachment/studies/:id/attachments/:name/compressChange the compression scheme that is used to store an attachment.
  • GETGet attachment (no decompression)/studies/:id/attachments/:name/compressed-dataGet the (binary) content of one attachment associated with the given study. The attachment will not be decompressed if StorageCompression is true.
  • GETGet MD5 of attachment on disk/studies/:id/attachments/:name/compressed-md5Get the MD5 hash of one attachment associated with the given study, as stored on the disk. This is different from .../md5 iff EnableStorage is true.
  • GETGet size of attachment on disk/studies/:id/attachments/:name/compressed-sizeGet the size of one attachment associated with the given study, as stored on the disk. This is different from .../size iff EnableStorage is true.
  • GETGet attachment/studies/:id/attachments/:name/dataGet the (binary) content of one attachment associated with the given study
  • GETGet info about the attachment/studies/:id/attachments/:name/infoGet all the information about the attachment associated with the given study
  • GETIs attachment compressed?/studies/:id/attachments/:name/is-compressedTest whether the attachment has been stored as a compressed file on the disk.
  • GETGet MD5 of attachment/studies/:id/attachments/:name/md5Get the MD5 hash of one attachment associated with the given study
  • GETGet size of attachment/studies/:id/attachments/:name/sizeGet the size of one attachment associated with the given study
  • POSTUncompress attachment/studies/:id/attachments/:name/uncompressChange the compression scheme that is used to store an attachment.
  • POSTVerify attachment/studies/:id/attachments/:name/verify-md5Verify that the attachment is not corrupted, by validating its MD5 hash
  • GETGet child instances/studies/:id/instances?full=true&requestedTags=string&short=trueGet detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL
  • GETGet tags of instances/studies/:id/instances-tags?ignore-length=string&short=true&simplify=trueGet the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
  • GETCreate DICOMDIR media/studies/:id/media?extended=string&filename=string&transcode=stringSynchronously create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might…
  • POSTCreate DICOMDIR media/studies/:id/mediaCreate a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL
  • POSTMerge study/studies/:id/mergeStart a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier is provided in the URL:…
  • GETList metadata/studies/:id/metadata?expand=stringGet the list of metadata that are associated with the given study
  • GETGet metadata/studies/:id/metadata/:nameGet the value of a metadata that is associated with the given study
  • PUTSet metadata/studies/:id/metadata/:nameSet the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
  • DELETEDelete metadata/studies/:id/metadata/:nameDelete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
  • POSTModify study/studies/:id/modifyStart a job that will modify all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored…
  • GETGet study module/studies/:id/module?ignore-length=string&short=true&simplify=trueGet the study module of the DICOM study whose Orthanc identifier is provided in the URL
  • GETGet patient module of study/studies/:id/module-patient?ignore-length=string&short=true&simplify=trueGet the patient module of the DICOM study whose Orthanc identifier is provided in the URL
  • GETGet parent patient/studies/:id/patient?full=true&requestedTags=string&short=trueGet detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL
  • POSTReconstruct tags & optionally files of study/studies/:id/reconstructReconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have…
  • GETGet child series/studies/:id/series?full=true&requestedTags=string&short=trueGet detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL
  • GETGet shared tags/studies/:id/shared-tags?short=true&simplify=trueExtract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
  • POSTSplit study/studies/:id/splitStart a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, by taking some of its children series or instances out of it…
  • GETGet study statistics/studies/:id/statisticsGet statistics about the given study

Logs

  • GETGet main log level/tools/log-levelGet the main log level of Orthanc
  • PUTSet main log level/tools/log-levelSet the main log level of Orthanc
  • GETGet log level for `dicom`/tools/log-level-dicomGet the log level of the log category dicom
  • PUTSet log level for `dicom`/tools/log-level-dicomSet the log level of the log category dicom
  • GETGet log level for `generic`/tools/log-level-genericGet the log level of the log category generic
  • PUTSet log level for `generic`/tools/log-level-genericSet the log level of the log category generic
  • GETGet log level for `http`/tools/log-level-httpGet the log level of the log category http
  • PUTSet log level for `http`/tools/log-level-httpSet the log level of the log category http
  • GETGet log level for `jobs`/tools/log-level-jobsGet the log level of the log category jobs
  • PUTSet log level for `jobs`/tools/log-level-jobsSet the log level of the log category jobs
  • GETGet log level for `lua`/tools/log-level-luaGet the log level of the log category lua
  • PUTSet log level for `lua`/tools/log-level-luaSet the log level of the log category lua
  • GETGet log level for `plugins`/tools/log-level-pluginsGet the log level of the log category plugins
  • PUTSet log level for `plugins`/tools/log-level-pluginsSet the log level of the log category plugins
  • GETGet log level for `sqlite`/tools/log-level-sqliteGet the log level of the log category sqlite
  • PUTSet log level for `sqlite`/tools/log-level-sqliteSet the log level of the log category sqlite

API details

Base URL
https://demo.orthanc-server.com
Authentication
None declared in the description
Operations
274 operations on 227 pathsGET 160POST 74PUT 23DELETE 17
6 marked deprecated
Main resources
Instances 54Networking 41Studies 38Patients 37Series 37System 34Logs 16Jobs 7Other 6Tracking changes 4
Response formats
application/json image/jpeg image/png image/x-portable-arbitrarymap
Description format
OpenAPI 3.0.0, API version 1.11.3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Orthanc API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Orthanc API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List changes” (GET /changes?limit=0.0&since=0.0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Orthanc API?

This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc. This reference is automatically generated from… It is listed under Developer tools and has 274 endpoints.

Who publishes the Orthanc API?

It is listed from Orthanc Server's public API description (an OpenAPI document), not published by Orthanc Server on Swastik Codes. Anyone who controls orthanc-server.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Orthanc API?

Requests go to https://demo.orthanc-server.com. Endpoint paths are added to this base URL.

How do I authenticate with the Orthanc API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Orthanc API have?

274 operations on 227 paths (160 GET, 74 POST, 23 PUT, 17 DELETE). The largest groups are Instances, Networking, Studies, Patients.

Is forking the Orthanc API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.