v1

latestOpenAPI 3.0.02026-07-132990743.4 KB

System

Get system information

Get system information about Orthanc

get/system

Response

ApiVersionnumber

Version of the REST API

Capabilitiesobject

Whether the database back-end supports optional features like 'HasExtendedChanges', 'HasExtendedFind' (new in Orthanc 1.12.5), 'HasKeyValueStores', 'HasQueues' (new in Orthanc 1.12.8), and 'HasReserveQueueValue' (new in Orthanc 1.12.10)

CheckRevisionsboolean

Whether Orthanc handle revisions of metadata and attachments to deal with multiple writers (new in Orthanc 1.9.2)

DatabaseBackendPluginstring

Information about the installed database index plugin (null if no such plugin is installed)

DatabaseServerIdentifierstring

ID of the server in the database (when running multiple Orthanc on the same DB)

DatabaseVersionnumber

Version of the database: https://orthanc.uclouvain.be/book/developers/db-versioning.html

DicomAetstring

The DICOM AET of Orthanc

DicomDefaultRetrieveMethodstring

The DicomDefaultRetrieveMethod configuration

DicomPortnumber

The port to the DICOM server of Orthanc

HasLabelsboolean

Whether the database back-end supports labels (new in Orthanc 1.12.0)

HttpPortnumber

The port to the HTTP server of Orthanc

IngestTranscodingstring

Whether instances are transcoded when ingested into Orthanc (`` if no transcoding is performed) (new in Orthanc 1.11.0)

IsHttpServerSecureboolean

Whether the REST API is properly secured (assuming no reverse proxy is in use): https://orthanc.uclouvain.be/book/faq/security.html#securing-the-http-server

MainDicomTagsobject

The list of MainDicomTags saved in DB for each resource level (new in Orthanc 1.11.0)

MaximumPatientCountnumber

The configured MaximumPatientCount (new in Orthanc 1.12.4)

MaximumStorageModestring

The configured MaximumStorageMode (new in Orthanc 1.11.3)

MaximumStorageSizenumber

The configured MaximumStorageSize in MB (new in Orthanc 1.11.3)

Namestring

The name of the Orthanc server, cf. the Name configuration option

OverwriteInstancesboolean

Whether instances are overwritten when re-ingested (new in Orthanc 1.11.0)

PatientLevelEnabledboolean

Whether Patient level routes and sanity checks are enabled (new in Orthanc 1.12.11)

PluginsEnabledboolean

Whether Orthanc was built with support for plugins

ReadOnlyboolean

Whether Orthanc is running in read only mode (new in Orthanc 1.12.5)

StorageAreaPluginstring

Information about the installed storage area plugin (null if no such plugin is installed)

StorageCompressionboolean

Whether storage compression is enabled (new in Orthanc 1.11.0)

UserMetadataobject

The configured UserMetadata (new in Orthanc 1.12.0)

Versionstring

Version of Orthanc

Example response

{
  "ApiVersion": 30,
  "Capabilities": {
    "HasExtendedChanges": true,
    "HasExtendedFind": true,
    "HasKeyValueStores": true,
    "HasQueues": true,
    "HasReserveQueueValue": true
  },
  "CheckRevisions": false,
  "DatabaseBackendPlugin": null,
  "DatabaseServerIdentifier": "be2ba798-1cb577e0-483accf5-d286e8f5-de2599df",
  "DatabaseVersion": 6,
  "DicomAet": "ORTHANC",
  "DicomDefaultRetrieveMethod": "C-MOVE",
  "DicomPort": 4242,
  "HasLabels": true,
  "HttpPort": 8042,
  "IngestTranscoding": "",
  "IsHttpServerSecure": true,
  "MainDicomTags": {
    "Instance": "0008,0012;0008,0013;0008,0018;0020,0012;0020,0013;0020,0032;0020,0037;0020,0100;0020,4000;0028,0008;0054,1330",
    "Patient": "0010,0010;0010,0020;0010,0030;0010,0040;0010,1000",
    "Series": "0008,0021;0008,0031;0008,0060;0008,0070;0008,0201;0008,1010;0008,103e;0008,1070;0018,0010;0018,0015;0018,0024;0018,1030;0018,1090;0018,1400;0020,000e;0020,0011;0020,0037;0020,0105;0020,1002;0040,0244;0040,0245;0040,0254;0040,0275;0054,0081;0054,0101;0054,1000",
    "Study": "0008,0020;0008,0030;0008,0050;0008,0080;0008,0090;0008,0201;0008,1030;0020,000d;0020,0010;0032,1032;0032,1060"
  },
  "MaximumPatientCount": 0,
  "MaximumStorageMode": "Recycle",
  "MaximumStorageSize": 0,
  "Name": "Orthanc Demo",
  "OverwriteInstances": false,
  "PatientLevelEnabled": true,
  "PluginsEnabled": true,
  "ReadOnly": false,
  "StorageAreaPlugin": null,
  "StorageCompression": false,
  "UserMetadata": {},
  "Version": "1.12.11"
}