Orthanc API API

Overview

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)).

Orthanc API is a documents & productivity API from orthanc-server.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 274 endpoints.

At a glance

Authentication

No auth

HTTPS

Yes

CORS

Unknown

Category

Documents & Productivity

Base URL

https://demo.orthanc-server.com/

Version

1.11.3

Endpoints

274

OpenAPI

Specification ↗

Spec updated

2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://demo.orthanc-server.com/changes" \
  -H "Accept: application/json"

const response = await fetch("https://demo.orthanc-server.com/changes", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://demo.orthanc-server.com/changes",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions