Orthanc API
This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ)).
Base URL:
Auth: unknown
Endpoints: 167
Reachable: unknown
CORS: unknown
https://demo.orthanc-server.com/Auth: unknown
Endpoints: 167
Reachable: unknown
CORS: unknown
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/changes | List changes | — | — | — |
GET |
/exports | List exports | — | — | — |
GET |
/instances | List the available instances | — | — | — |
GET |
/instances/{id} | Get information about some instance | — | — | — |
GET |
/instances/{id}/attachments | List attachments | — | — | — |
GET |
/instances/{id}/attachments/{name} | List operations on attachments | — | — | — |
GET |
/instances/{id}/attachments/{name}/compressed-data | Get attachment (no decompression) | — | — | — |
GET |
/instances/{id}/attachments/{name}/compressed-md5 | Get MD5 of attachment on disk | — | — | — |
GET |
/instances/{id}/attachments/{name}/compressed-size | Get size of attachment on disk | — | — | — |
GET |
/instances/{id}/attachments/{name}/data | Get attachment | — | — | — |
GET |
/instances/{id}/attachments/{name}/info | Get info about the attachment | — | — | — |
GET |
/instances/{id}/attachments/{name}/is-compressed | Is attachment compressed? | — | — | — |
GET |
/instances/{id}/attachments/{name}/md5 | Get MD5 of attachment | — | — | — |
GET |
/instances/{id}/attachments/{name}/size | Get size of attachment | — | — | — |
GET |
/instances/{id}/content | Get raw tag | — | — | — |
GET |
/instances/{id}/file | Download DICOM | — | — | — |
GET |
/instances/{id}/frames | List available frames | — | — | — |
GET |
/instances/{id}/frames/{frame} | List operations | — | — | — |
GET |
/instances/{id}/frames/{frame}/image-int16 | Decode a frame (int16) | — | — | — |
GET |
/instances/{id}/frames/{frame}/image-uint16 | Decode a frame (uint16) | — | — | — |
GET |
/instances/{id}/frames/{frame}/image-uint8 | Decode a frame (uint8) | — | — | — |
GET |
/instances/{id}/frames/{frame}/matlab | Decode frame for Matlab | — | — | — |
GET |
/instances/{id}/frames/{frame}/numpy | Decode frame for numpy | — | — | — |
GET |
/instances/{id}/frames/{frame}/preview | Decode a frame (preview) | — | — | — |
GET |
/instances/{id}/frames/{frame}/raw | Access raw frame | — | — | — |
GET |
/instances/{id}/frames/{frame}/raw.gz | Access raw frame (compressed) | — | — | — |
GET |
/instances/{id}/frames/{frame}/rendered | Render a frame | — | — | — |
GET |
/instances/{id}/header | Get DICOM meta-header | — | — | — |
GET |
/instances/{id}/image-int16 | Decode an image (int16) | — | — | — |
GET |
/instances/{id}/image-uint16 | Decode an image (uint16) | — | — | — |
GET |
/instances/{id}/image-uint8 | Decode an image (uint8) | — | — | — |
GET |
/instances/{id}/labels | List labels | — | — | — |
GET |
/instances/{id}/labels/{label} | Test label | — | — | — |
GET |
/instances/{id}/matlab | Decode frame for Matlab | — | — | — |
GET |
/instances/{id}/metadata | List metadata | — | — | — |
GET |
/instances/{id}/metadata/{name} | Get metadata | — | — | — |
GET |
/instances/{id}/module | Get instance module | — | — | — |
GET |
/instances/{id}/numpy | Decode instance for numpy | — | — | — |
GET |
/instances/{id}/patient | Get parent patient | — | — | — |
GET |
/instances/{id}/pdf | Get embedded PDF | — | — | — |
GET |
/instances/{id}/preview | Decode an image (preview) | — | — | — |
GET |
/instances/{id}/rendered | Render an image | — | — | — |
GET |
/instances/{id}/series | Get parent series | — | — | — |
GET |
/instances/{id}/simplified-tags | Get human-readable tags | — | — | — |
GET |
/instances/{id}/statistics | Get instance statistics | — | — | — |
GET |
/instances/{id}/study | Get parent study | — | — | — |
GET |
/instances/{id}/tags | Get DICOM tags | — | — | — |
GET |
/jobs | List jobs | — | — | — |
GET |
/jobs/{id} | Get job | — | — | — |
GET |
/jobs/{id}/{key} | Get job output | — | — | — |
GET |
/modalities | List DICOM modalities | — | — | — |
GET |
/modalities/{id} | List operations on modality | — | — | — |
POST |
/modalities/{id}/find | Hierarchical C-FIND SCU | — | — | — |
POST |
/modalities/{id}/find-instance | C-FIND SCU for instances | — | — | — |
POST |
/modalities/{id}/find-patient | C-FIND SCU for patients | — | — | — |
POST |
/modalities/{id}/find-series | C-FIND SCU for series | — | — | — |
POST |
/modalities/{id}/find-study | C-FIND SCU for studies | — | — | — |
POST |
/modalities/{id}/find-worklist | C-FIND SCU for worklist | — | — | — |
POST |
/modalities/{id}/query | Trigger C-FIND SCU | — | — | — |
GET |
/patients | List the available patients | — | — | — |
GET |
/patients/{id} | Get information about some patient | — | — | — |
GET |
/patients/{id}/archive | Create ZIP archive | — | — | — |
GET |
/patients/{id}/attachments | List attachments | — | — | — |
GET |
/patients/{id}/attachments/{name} | List operations on attachments | — | — | — |
GET |
/patients/{id}/attachments/{name}/compressed-data | Get attachment (no decompression) | — | — | — |
GET |
/patients/{id}/attachments/{name}/compressed-md5 | Get MD5 of attachment on disk | — | — | — |
GET |
/patients/{id}/attachments/{name}/compressed-size | Get size of attachment on disk | — | — | — |
GET |
/patients/{id}/attachments/{name}/data | Get attachment | — | — | — |
GET |
/patients/{id}/attachments/{name}/info | Get info about the attachment | — | — | — |
GET |
/patients/{id}/attachments/{name}/is-compressed | Is attachment compressed? | — | — | — |
GET |
/patients/{id}/attachments/{name}/md5 | Get MD5 of attachment | — | — | — |
GET |
/patients/{id}/attachments/{name}/size | Get size of attachment | — | — | — |
GET |
/patients/{id}/instances | Get child instances | — | — | — |
GET |
/patients/{id}/instances-tags | Get tags of instances | — | — | — |
GET |
/patients/{id}/labels | List labels | — | — | — |
GET |
/patients/{id}/labels/{label} | Test label | — | — | — |
GET |
/patients/{id}/media | Create DICOMDIR media | — | — | — |
GET |
/patients/{id}/metadata | List metadata | — | — | — |
GET |
/patients/{id}/metadata/{name} | Get metadata | — | — | — |
GET |
/patients/{id}/module | Get patient module | — | — | — |
GET |
/patients/{id}/protected | Is the patient protected against recycling? | — | — | — |
GET |
/patients/{id}/series | Get child series | — | — | — |
GET |
/patients/{id}/shared-tags | Get shared tags | — | — | — |
GET |
/patients/{id}/statistics | Get patient statistics | — | — | — |
GET |
/patients/{id}/studies | Get child studies | — | — | — |
GET |
/peers | List Orthanc peers | — | — | — |
GET |
/peers/{id} | List operations on peer | — | — | — |
GET |
/peers/{id}/system | Get peer system information | — | — | — |
GET |
/plugins | List plugins | — | — | — |
GET |
/plugins/explorer.js | JavaScript extensions to Orthanc Explorer | — | — | — |
GET |
/plugins/{id} | Get plugin | — | — | — |
GET |
/queries | List query/retrieve operations | — | — | — |
GET |
/queries/{id} | List operations on a query | — | — | — |
GET |
/queries/{id}/answers | List answers to a query | — | — | — |
GET |
/queries/{id}/answers/{index} | List operations on an answer | — | — | — |
GET |
/queries/{id}/answers/{index}/content | Get one answer | — | — | — |
POST |
/queries/{id}/answers/{index}/query-instances | Query the child instances of an answer | — | — | — |
POST |
/queries/{id}/answers/{index}/query-series | Query the child series of an answer | — | — | — |
POST |
/queries/{id}/answers/{index}/query-studies | Query the child studies of an answer | — | — | — |
GET |
/queries/{id}/level | Get level of original query | — | — | — |
GET |
/queries/{id}/modality | Get modality of original query | — | — | — |
GET |
/queries/{id}/query | Get original query arguments | — | — | — |
GET |
/series | List the available series | — | — | — |
GET |
/series/{id} | Get information about some series | — | — | — |
GET |
/series/{id}/archive | Create ZIP archive | — | — | — |
GET |
/series/{id}/attachments | List attachments | — | — | — |
GET |
/series/{id}/attachments/{name} | List operations on attachments | — | — | — |
GET |
/series/{id}/attachments/{name}/compressed-data | Get attachment (no decompression) | — | — | — |
GET |
/series/{id}/attachments/{name}/compressed-md5 | Get MD5 of attachment on disk | — | — | — |
GET |
/series/{id}/attachments/{name}/compressed-size | Get size of attachment on disk | — | — | — |
GET |
/series/{id}/attachments/{name}/data | Get attachment | — | — | — |
GET |
/series/{id}/attachments/{name}/info | Get info about the attachment | — | — | — |
GET |
/series/{id}/attachments/{name}/is-compressed | Is attachment compressed? | — | — | — |
GET |
/series/{id}/attachments/{name}/md5 | Get MD5 of attachment | — | — | — |
GET |
/series/{id}/attachments/{name}/size | Get size of attachment | — | — | — |
GET |
/series/{id}/instances | Get child instances | — | — | — |
GET |
/series/{id}/instances-tags | Get tags of instances | — | — | — |
GET |
/series/{id}/labels | List labels | — | — | — |
GET |
/series/{id}/labels/{label} | Test label | — | — | — |
GET |
/series/{id}/media | Create DICOMDIR media | — | — | — |
GET |
/series/{id}/metadata | List metadata | — | — | — |
GET |
/series/{id}/metadata/{name} | Get metadata | — | — | — |
GET |
/series/{id}/module | Get series module | — | — | — |
GET |
/series/{id}/numpy | Decode series for numpy | — | — | — |
GET |
/series/{id}/ordered-slices | Order the slices | — | — | — |
GET |
/series/{id}/patient | Get parent patient | — | — | — |
GET |
/series/{id}/shared-tags | Get shared tags | — | — | — |
GET |
/series/{id}/statistics | Get series statistics | — | — | — |
GET |
/series/{id}/study | Get parent study | — | — | — |
GET |
/statistics | Get database statistics | — | — | — |
GET |
/storage-commitment/{id} | Get storage commitment report | — | — | — |
GET |
/studies | List the available studies | — | — | — |
GET |
/studies/{id} | Get information about some study | — | — | — |
GET |
/studies/{id}/archive | Create ZIP archive | — | — | — |
GET |
/studies/{id}/attachments | List attachments | — | — | — |
GET |
/studies/{id}/attachments/{name} | List operations on attachments | — | — | — |
GET |
/studies/{id}/attachments/{name}/compressed-data | Get attachment (no decompression) | — | — | — |
GET |
/studies/{id}/attachments/{name}/compressed-md5 | Get MD5 of attachment on disk | — | — | — |
GET |
/studies/{id}/attachments/{name}/compressed-size | Get size of attachment on disk | — | — | — |
GET |
/studies/{id}/attachments/{name}/data | Get attachment | — | — | — |
GET |
/studies/{id}/attachments/{name}/info | Get info about the attachment | — | — | — |
GET |
/studies/{id}/attachments/{name}/is-compressed | Is attachment compressed? | — | — | — |
GET |
/studies/{id}/attachments/{name}/md5 | Get MD5 of attachment | — | — | — |
GET |
/studies/{id}/attachments/{name}/size | Get size of attachment | — | — | — |
GET |
/studies/{id}/instances | Get child instances | — | — | — |
GET |
/studies/{id}/instances-tags | Get tags of instances | — | — | — |
GET |
/studies/{id}/labels | List labels | — | — | — |
GET |
/studies/{id}/labels/{label} | Test label | — | — | — |
GET |
/studies/{id}/media | Create DICOMDIR media | — | — | — |
GET |
/studies/{id}/metadata | List metadata | — | — | — |
GET |
/studies/{id}/metadata/{name} | Get metadata | — | — | — |
GET |
/studies/{id}/module | Get study module | — | — | — |
GET |
/studies/{id}/module-patient | Get patient module of study | — | — | — |
GET |
/studies/{id}/patient | Get parent patient | — | — | — |
GET |
/studies/{id}/series | Get child series | — | — | — |
GET |
/studies/{id}/shared-tags | Get shared tags | — | — | — |
GET |
/studies/{id}/statistics | Get study statistics | — | — | — |
GET |
/system | Get system information | — | — | — |
GET |
/tools | List operations | — | — | — |
GET |
/tools/accepted-transfer-syntaxes | Get accepted transfer syntaxes | — | — | — |
GET |
/tools/default-encoding | Get default encoding | — | — | — |
GET |
/tools/dicom-conformance | Get DICOM conformance | — | — | — |
POST |
/tools/find | Look for local resources | — | — | — |
GET |
/tools/generate-uid | Generate an identifier | — | — | — |
GET |
/tools/labels | Get all the used labels | — | — | — |
GET |
/tools/log-level | Get main log level | — | — | — |
GET |
/tools/log-level-dicom | Get log level for `dicom` | — | — | — |
GET |
/tools/log-level-generic | Get log level for `generic` | — | — | — |
GET |
/tools/log-level-http | Get log level for `http` | — | — | — |
GET |
/tools/log-level-jobs | Get log level for `jobs` | — | — | — |
GET |
/tools/log-level-lua | Get log level for `lua` | — | — | — |
GET |
/tools/log-level-plugins | Get log level for `plugins` | — | — | — |
GET |
/tools/log-level-sqlite | Get log level for `sqlite` | — | — | — |
POST |
/tools/lookup | Look for DICOM identifiers | — | — | — |
GET |
/tools/metrics | Are metrics collected? | — | — | — |
GET |
/tools/metrics-prometheus | Get usage metrics | — | — | — |
GET |
/tools/now | Get UTC time | — | — | — |
GET |
/tools/now-local | Get local time | — | — | — |
GET |
/tools/unknown-sop-class-accepted | Is unknown SOP class accepted? | — | — | — |