Application Programming Interfaces (API)
Stroom’ public REST APIs for querying and interacting with all aspects of Stroom.
The page that you are currently viewing is for an old version of Stroom (7.1). The documentation for the latest version of Stroom (7.6) can be found using the version drop-down at the top of the screen or by clicking here.
User Guide
Reference documentation for how to use Stroom.
Indexing data
Indexing data for querying.
Content Naming Conventions
A set of guidelines for how to name and organise your content.
Concepts
Describes a number of core concepts involved in using Stroom.
Dashboards
The means of displaying and visualising the results of queries.
Data Retention
Controlling the purging/retention of old data.
Editing and Viewing Data
How to view data and edit content.
Event Feeds
Feeds provide the means to logically group data common to a data format and source system.
Finding Things
How to find things in Stroom, for example content, simple string values, etc.
Nodes
Configuring the nodes in a Stroom cluster.
Pipelines
Pipelines are the mechanism for processing and transforming ingested data.
Properties
Configuration of Stroom’s application properties.
Security
There are many aspects of security that should be considered when installing and running Stroom.
Stroom Jobs
Managing background jobs.
Tools
Various additional tools to assist in administering Stroom and accessing its data.
Volumes
Stroom’s logical storage volumes for storing event and index data.
Last modified November 1, 2024: Merge pull request #107 from gchq/7.1-add-keycloak-setup (9e224e4)