Cheat sheet of the REST API

This quick reference of the REST API of Orthanc is automatically generated from the source code of Orthanc. Clicking on one of the HTTP methods will open its full OpenAPI documentation.

If you are looking for samples, check out the dedicated FAQ entry.

Reference

Path	GET	POST	DELETE	PUT	Summary
/changes	GET		DELETE		List changes
/exports	GET		DELETE		List exports
/instances	GET	POST			List the available instances
/instances/{id}	GET		DELETE		Get information about some instance
/instances/{id}/anonymize		POST			Anonymize instance
/instances/{id}/attachments	GET				List attachments
/instances/{id}/attachments/{name}	GET		DELETE	PUT	List operations on attachments
/instances/{id}/attachments/{name}/compress		POST			Compress attachment
/instances/{id}/attachments/{name}/compressed-data	GET				Get attachment (no decompression)
/instances/{id}/attachments/{name}/compressed-md5	GET				Get MD5 of attachment on disk
/instances/{id}/attachments/{name}/compressed-size	GET				Get size of attachment on disk
/instances/{id}/attachments/{name}/data	GET				Get attachment
/instances/{id}/attachments/{name}/info	GET				Get info about the attachment
/instances/{id}/attachments/{name}/is-compressed	GET				Is attachment compressed?
/instances/{id}/attachments/{name}/md5	GET				Get MD5 of attachment
/instances/{id}/attachments/{name}/size	GET				Get size of attachment
/instances/{id}/attachments/{name}/uncompress		POST			Uncompress attachment
/instances/{id}/attachments/{name}/verify-md5		POST			Verify attachment
/instances/{id}/content/{path}	GET				Get raw tag
/instances/{id}/export		POST			Write DICOM onto filesystem
/instances/{id}/file	GET				Download DICOM
/instances/{id}/frames	GET				List available frames
/instances/{id}/frames/{frame}	GET				List operations
/instances/{id}/frames/{frame}/image-int16	GET				Decode a frame (int16)
/instances/{id}/frames/{frame}/image-uint16	GET				Decode a frame (uint16)
/instances/{id}/frames/{frame}/image-uint8	GET				Decode a frame (uint8)
/instances/{id}/frames/{frame}/matlab	GET				Decode frame for Matlab
/instances/{id}/frames/{frame}/numpy	GET				Decode frame for numpy
/instances/{id}/frames/{frame}/preview	GET				Decode a frame (preview)
/instances/{id}/frames/{frame}/raw	GET				Access raw frame
/instances/{id}/frames/{frame}/raw.gz	GET				Access raw frame (compressed)
/instances/{id}/frames/{frame}/rendered	GET				Render a frame
/instances/{id}/header	GET				Get DICOM meta-header
/instances/{id}/image-int16	GET				Decode an image (int16)
/instances/{id}/image-uint16	GET				Decode an image (uint16)
/instances/{id}/image-uint8	GET				Decode an image (uint8)
/instances/{id}/labels	GET				List labels
/instances/{id}/labels/{label}	GET		DELETE	PUT	Test label
/instances/{id}/matlab	GET				Decode frame for Matlab
/instances/{id}/metadata	GET				List metadata
/instances/{id}/metadata/{name}	GET		DELETE	PUT	Get metadata
/instances/{id}/modify		POST			Modify instance
/instances/{id}/module	GET				Get instance module
/instances/{id}/numpy	GET				Decode instance for numpy
/instances/{id}/patient	GET				Get parent patient
/instances/{id}/pdf	GET				Get embedded PDF
/instances/{id}/preview	GET				Decode an image (preview)
/instances/{id}/reconstruct		POST			Reconstruct tags & optionally files of instance
/instances/{id}/rendered	GET				Render an image
/instances/{id}/series	GET				Get parent series
/instances/{id}/simplified-tags	GET				Get human-readable tags
/instances/{id}/statistics	GET				Get instance statistics
/instances/{id}/study	GET				Get parent study
/instances/{id}/tags	GET				Get DICOM tags
/jobs	GET				List jobs
/jobs/{id}	GET		DELETE		Get job
/jobs/{id}/cancel		POST			Cancel job
/jobs/{id}/pause		POST			Pause job
/jobs/{id}/resubmit		POST			Resubmit job
/jobs/{id}/resume		POST			Resume job
/jobs/{id}/{key}	GET		DELETE		Get job output
/modalities	GET				List DICOM modalities
/modalities/{id}	GET		DELETE	PUT	List operations on modality
/modalities/{id}/configuration	GET				Get modality configuration
/modalities/{id}/echo		POST			Trigger C-ECHO SCU
/modalities/{id}/find		(post)			(deprecated) Hierarchical C-FIND SCU
/modalities/{id}/find-instance		(post)			(deprecated) C-FIND SCU for instances
/modalities/{id}/find-patient		(post)			(deprecated) C-FIND SCU for patients
/modalities/{id}/find-series		(post)			(deprecated) C-FIND SCU for series
/modalities/{id}/find-study		(post)			(deprecated) C-FIND SCU for studies
/modalities/{id}/find-worklist		POST			C-FIND SCU for worklist
/modalities/{id}/move		POST			Trigger C-MOVE SCU
/modalities/{id}/query		POST			Trigger C-FIND SCU
/modalities/{id}/storage-commitment		POST			Trigger storage commitment request
/modalities/{id}/store		POST			Trigger C-STORE SCU
/modalities/{id}/store-straight		POST			Straight C-STORE SCU
/patients	GET				List the available patients
/patients/{id}	GET		DELETE		Get information about some patient
/patients/{id}/anonymize		POST			Anonymize patient
/patients/{id}/archive	GET	POST			Create ZIP archive
/patients/{id}/attachments	GET				List attachments
/patients/{id}/attachments/{name}	GET		DELETE	PUT	List operations on attachments
/patients/{id}/attachments/{name}/compress		POST			Compress attachment
/patients/{id}/attachments/{name}/compressed-data	GET				Get attachment (no decompression)
/patients/{id}/attachments/{name}/compressed-md5	GET				Get MD5 of attachment on disk
/patients/{id}/attachments/{name}/compressed-size	GET				Get size of attachment on disk
/patients/{id}/attachments/{name}/data	GET				Get attachment
/patients/{id}/attachments/{name}/info	GET				Get info about the attachment
/patients/{id}/attachments/{name}/is-compressed	GET				Is attachment compressed?
/patients/{id}/attachments/{name}/md5	GET				Get MD5 of attachment
/patients/{id}/attachments/{name}/size	GET				Get size of attachment
/patients/{id}/attachments/{name}/uncompress		POST			Uncompress attachment
/patients/{id}/attachments/{name}/verify-md5		POST			Verify attachment
/patients/{id}/instances	GET				Get child instances
/patients/{id}/instances-tags	GET				Get tags of instances
/patients/{id}/labels	GET				List labels
/patients/{id}/labels/{label}	GET		DELETE	PUT	Test label
/patients/{id}/media	GET	POST			Create DICOMDIR media
/patients/{id}/metadata	GET				List metadata
/patients/{id}/metadata/{name}	GET		DELETE	PUT	Get metadata
/patients/{id}/modify		POST			Modify patient
/patients/{id}/module	GET				Get patient module
/patients/{id}/protected	GET			PUT	Is the patient protected against recycling?
/patients/{id}/reconstruct		POST			Reconstruct tags & optionally files of patient
/patients/{id}/series	GET				Get child series
/patients/{id}/shared-tags	GET				Get shared tags
/patients/{id}/statistics	GET				Get patient statistics
/patients/{id}/studies	GET				Get child studies
/peers	GET				List Orthanc peers
/peers/{id}	GET		DELETE	PUT	List operations on peer
/peers/{id}/configuration	GET				Get peer configuration
/peers/{id}/store		POST			Send to Orthanc peer
/peers/{id}/store-straight		POST			Straight store to peer
/peers/{id}/system	GET				Get peer system information
/plugins	GET				List plugins
/plugins/explorer.js	GET				JavaScript extensions to Orthanc Explorer
/plugins/{id}	GET				Get plugin
/queries	GET				List query/retrieve operations
/queries/{id}	GET		DELETE		List operations on a query
/queries/{id}/answers	GET				List answers to a query
/queries/{id}/answers/{index}	GET				List operations on an answer
/queries/{id}/answers/{index}/content	GET				Get one answer
/queries/{id}/answers/{index}/query-instances		POST			Query the child instances of an answer
/queries/{id}/answers/{index}/query-series		POST			Query the child series of an answer
/queries/{id}/answers/{index}/query-studies		POST			Query the child studies of an answer
/queries/{id}/answers/{index}/retrieve		POST			Retrieve one answer
/queries/{id}/level	GET				Get level of original query
/queries/{id}/modality	GET				Get modality of original query
/queries/{id}/query	GET				Get original query arguments
/queries/{id}/retrieve		POST			Retrieve all answers
/series	GET				List the available series
/series/{id}	GET		DELETE		Get information about some series
/series/{id}/anonymize		POST			Anonymize series
/series/{id}/archive	GET	POST			Create ZIP archive
/series/{id}/attachments	GET				List attachments
/series/{id}/attachments/{name}	GET		DELETE	PUT	List operations on attachments
/series/{id}/attachments/{name}/compress		POST			Compress attachment
/series/{id}/attachments/{name}/compressed-data	GET				Get attachment (no decompression)
/series/{id}/attachments/{name}/compressed-md5	GET				Get MD5 of attachment on disk
/series/{id}/attachments/{name}/compressed-size	GET				Get size of attachment on disk
/series/{id}/attachments/{name}/data	GET				Get attachment
/series/{id}/attachments/{name}/info	GET				Get info about the attachment
/series/{id}/attachments/{name}/is-compressed	GET				Is attachment compressed?
/series/{id}/attachments/{name}/md5	GET				Get MD5 of attachment
/series/{id}/attachments/{name}/size	GET				Get size of attachment
/series/{id}/attachments/{name}/uncompress		POST			Uncompress attachment
/series/{id}/attachments/{name}/verify-md5		POST			Verify attachment
/series/{id}/instances	GET				Get child instances
/series/{id}/instances-tags	GET				Get tags of instances
/series/{id}/labels	GET				List labels
/series/{id}/labels/{label}	GET		DELETE	PUT	Test label
/series/{id}/media	GET	POST			Create DICOMDIR media
/series/{id}/metadata	GET				List metadata
/series/{id}/metadata/{name}	GET		DELETE	PUT	Get metadata
/series/{id}/modify		POST			Modify series
/series/{id}/module	GET				Get series module
/series/{id}/numpy	GET				Decode series for numpy
/series/{id}/ordered-slices	(get)				(deprecated) Order the slices
/series/{id}/patient	GET				Get parent patient
/series/{id}/reconstruct		POST			Reconstruct tags & optionally files of series
/series/{id}/shared-tags	GET				Get shared tags
/series/{id}/statistics	GET				Get series statistics
/series/{id}/study	GET				Get parent study
/statistics	GET				Get database statistics
/storage-commitment/{id}	GET				Get storage commitment report
/storage-commitment/{id}/remove		POST			Remove after storage commitment
/studies	GET				List the available studies
/studies/{id}	GET		DELETE		Get information about some study
/studies/{id}/anonymize		POST			Anonymize study
/studies/{id}/archive	GET	POST			Create ZIP archive
/studies/{id}/attachments	GET				List attachments
/studies/{id}/attachments/{name}	GET		DELETE	PUT	List operations on attachments
/studies/{id}/attachments/{name}/compress		POST			Compress attachment
/studies/{id}/attachments/{name}/compressed-data	GET				Get attachment (no decompression)
/studies/{id}/attachments/{name}/compressed-md5	GET				Get MD5 of attachment on disk
/studies/{id}/attachments/{name}/compressed-size	GET				Get size of attachment on disk
/studies/{id}/attachments/{name}/data	GET				Get attachment
/studies/{id}/attachments/{name}/info	GET				Get info about the attachment
/studies/{id}/attachments/{name}/is-compressed	GET				Is attachment compressed?
/studies/{id}/attachments/{name}/md5	GET				Get MD5 of attachment
/studies/{id}/attachments/{name}/size	GET				Get size of attachment
/studies/{id}/attachments/{name}/uncompress		POST			Uncompress attachment
/studies/{id}/attachments/{name}/verify-md5		POST			Verify attachment
/studies/{id}/instances	GET				Get child instances
/studies/{id}/instances-tags	GET				Get tags of instances
/studies/{id}/labels	GET				List labels
/studies/{id}/labels/{label}	GET		DELETE	PUT	Test label
/studies/{id}/media	GET	POST			Create DICOMDIR media
/studies/{id}/merge		POST			Merge study
/studies/{id}/metadata	GET				List metadata
/studies/{id}/metadata/{name}	GET		DELETE	PUT	Get metadata
/studies/{id}/modify		POST			Modify study
/studies/{id}/module	GET				Get study module
/studies/{id}/module-patient	GET				Get patient module of study
/studies/{id}/patient	GET				Get parent patient
/studies/{id}/reconstruct		POST			Reconstruct tags & optionally files of study
/studies/{id}/series	GET				Get child series
/studies/{id}/shared-tags	GET				Get shared tags
/studies/{id}/split		POST			Split study
/studies/{id}/statistics	GET				Get study statistics
/system	GET				Get system information
/tools	GET				List operations
/tools/accepted-transfer-syntaxes	GET			PUT	Get accepted transfer syntaxes
/tools/bulk-anonymize		POST			Anonymize a set of resources
/tools/bulk-content		POST			Describe a set of resources
/tools/bulk-delete		POST			Delete a set of resources
/tools/bulk-modify		POST			Modify a set of resources
/tools/create-archive	GET	POST			Create ZIP archive
/tools/create-dicom		POST			Create one DICOM instance
/tools/create-media	GET	POST			Create DICOMDIR media
/tools/create-media-extended	GET	POST			Create DICOMDIR media
/tools/default-encoding	GET			PUT	Get default encoding
/tools/dicom-conformance	GET				Get DICOM conformance
/tools/dicom-echo		POST			Trigger C-ECHO SCU
/tools/execute-script		POST			Execute Lua script
/tools/find		POST			Look for local resources
/tools/generate-uid	GET				Generate an identifier
/tools/invalidate-tags		POST			Invalidate DICOM-as-JSON summaries
/tools/labels	GET				Get all the used labels
/tools/log-level	GET			PUT	Get main log level
/tools/log-level-dicom	GET			PUT	Get log level for dicom
/tools/log-level-generic	GET			PUT	Get log level for generic
/tools/log-level-http	GET			PUT	Get log level for http
/tools/log-level-jobs	GET			PUT	Get log level for jobs
/tools/log-level-lua	GET			PUT	Get log level for lua
/tools/log-level-plugins	GET			PUT	Get log level for plugins
/tools/log-level-sqlite	GET			PUT	Get log level for sqlite
/tools/lookup		POST			Look for DICOM identifiers
/tools/metrics	GET			PUT	Are metrics collected?
/tools/metrics-prometheus	GET				Get usage metrics
/tools/now	GET				Get UTC time
/tools/now-local	GET				Get local time
/tools/reconstruct		POST			Reconstruct all the index
/tools/reset		POST			Restart Orthanc
/tools/shutdown		POST			Shutdown Orthanc
/tools/unknown-sop-class-accepted	GET			PUT	Is unknown SOP class accepted?

NB: Up to Orthanc 1.8.1, this cheat sheet was manually published as an online spreadsheet. This spreadsheet is still available online for history purpose, but is now left unmaintained.