Application Programming Interfaces (API)

Stroom’ public REST APIs for querying and interacting with all aspects of Stroom.

Stroom has many public REST APIs to allow other systems to interact with Stroom. Everything that can be done via the user interface can also be done using the API.

All methods on the API will are authenticated and authorised, so the permissions will be exactly the same as if the API user is using the Stroom user interface directly.


API Specification

Details of the API specifcation and how to find what API endpoints are available.

Calling an API

How to call a method on the Stroom API using curl.

Query APIs

The APIs to allow other systems to query the data held in Stroom.

Export Content API

An API method for exporting all Stroom content to a zip file.

Reference Data

How to perform reference data loads and lookups using the API.

Last modified April 25, 2024: Update 7.3 DB migs (f38e2e3)