API Specification
Details of the API specification and how to find what API endpoints are available.
Application Programming Interfaces (API)
Stroom’ public REST APIs for querying and interacting with all aspects of Stroom.
Stroom has many public REST
APIs
API
Application Programming Interface. An interface that one system can present so other systems can use it to communicate. Stroom has a number of APIs, e.g. its many REST APIs and its Click to see more details... to allow other systems to interact with Stroom.
Everything that can be done via the user interface can also be done using the API./datafeed interface for data receipt.
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.
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.
CSV Search API
The API for running a Stroom Query Language query and getting the results back as CSV.
Export Content API
An API method for exporting all Stroom content to a zip file.
Reference Data API
How to perform reference data loads and lookups using the API.
Data Download API
The API for downloading stream data in ZIP form.
Authentication Proxy
An endpoint to use Stroom as a proxy for an external IDP to obtain access tokens.
Explorer API
The API for managing the folders and documents in the explorer tree.
Feed API
The API for fetching and updating feeds.
Last modified October 20, 2026: Merge pull request #144 from gchq/add-7.14-rel-notes (2c6fb22)