Skip to content
Project management & work tracking

orthanc-server.com

Orthanc sandbox and mock 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-openap Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
274
Collections
-
Event types
-
Start this simulation
example request
curl https://your-orthanc-server.slurry.io/changes \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version 1.11.3.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 274.

  • GET/changes
  • DELETE/changes
  • GET/exports
  • DELETE/exports
  • GET/instances
  • POST/instances
  • GET/instances/{id}
  • DELETE/instances/{id}
  • POST/instances/{id}/anonymize
  • GET/instances/{id}/attachments
  • GET/instances/{id}/attachments/{name}
  • PUT/instances/{id}/attachments/{name}