---
title: "Get system information"
method: GET
path: "/system"
tags: ["System"]
---

# Get system information

`GET /system`

Get system information about Orthanc

## Response `200`

- object
  - `ApiVersion` number — Version of the REST API
  - `Capabilities` object — 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)
  - `CheckRevisions` boolean — Whether Orthanc handle revisions of metadata and attachments to deal with multiple writers (new in Orthanc 1.9.2)
  - `DatabaseBackendPlugin` string — Information about the installed database index plugin (`null` if no such plugin is installed)
  - `DatabaseServerIdentifier` string — ID of the server in the database (when running multiple Orthanc on the same DB)
  - `DatabaseVersion` number — Version of the database: https://orthanc.uclouvain.be/book/developers/db-versioning.html
  - `DicomAet` string — The DICOM AET of Orthanc
  - `DicomDefaultRetrieveMethod` string — The DicomDefaultRetrieveMethod configuration
  - `DicomPort` number — The port to the DICOM server of Orthanc
  - `HasLabels` boolean — Whether the database back-end supports labels (new in Orthanc 1.12.0)
  - `HttpPort` number — The port to the HTTP server of Orthanc
  - `IngestTranscoding` string — Whether instances are transcoded when ingested into Orthanc (`` if no transcoding is performed) (new in Orthanc 1.11.0)
  - `IsHttpServerSecure` boolean — 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
  - `MainDicomTags` object — The list of MainDicomTags saved in DB for each resource level (new in Orthanc 1.11.0)
  - `MaximumPatientCount` number — The configured MaximumPatientCount (new in Orthanc 1.12.4)
  - `MaximumStorageMode` string — The configured MaximumStorageMode (new in Orthanc 1.11.3)
  - `MaximumStorageSize` number — The configured MaximumStorageSize in MB (new in Orthanc 1.11.3)
  - `Name` string — The name of the Orthanc server, cf. the `Name` configuration option
  - `OverwriteInstances` boolean — Whether instances are overwritten when re-ingested (new in Orthanc 1.11.0)
  - `PatientLevelEnabled` boolean — Whether Patient level routes and sanity checks are enabled (new in Orthanc 1.12.11)
  - `PluginsEnabled` boolean — Whether Orthanc was built with support for plugins
  - `ReadOnly` boolean — Whether Orthanc is running in read only mode (new in Orthanc 1.12.5)
  - `StorageAreaPlugin` string — Information about the installed storage area plugin (`null` if no such plugin is installed)
  - `StorageCompression` boolean — Whether storage compression is enabled (new in Orthanc 1.11.0)
  - `UserMetadata` object — The configured UserMetadata (new in Orthanc 1.12.0)
  - `Version` string — Version of Orthanc

---

[API](https://skmtc.net/uclouvain/apis/orthanc-api.md) · [All operations](https://skmtc.net/uclouvain/apis/orthanc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uclouvain/orthanc-api/versions/9297c4930d96/schema)