← API Index  / 

Flow API Documentation

Select a section to open the interactive API explorer. Each section loads independently for faster rendering.

Flows

Create, read, update, delete, and clone flow definitions. Run per-flow or bulk test suites.

6 paths›

Recipes

Manage recipes — versioned integration configurations. CRUD, execution, version history, and remote install/deploy.

11 paths›

Shared Configs

Manage shared configuration objects referenced by flows and recipes. CRUD, clone, and refresh.

4 paths›

Triggers

Flow trigger definitions and trigger run logs (last run, all runs, statistics).

6 paths›

Miscellaneous

Repository-wide summary (all flows, configs, and triggers in one response) and resource file upload.

2 paths›

Patch Sets

Manage patch sets — named collections of JSON patch operations applied to integration configurations.

2 paths›

User Preferences

Store and retrieve per-user UI and application preferences.

2 paths›

Shared Processors

Create, read, update, delete, and clone shared stream processor definitions.

3 paths›

Built-in Processors

Browse the catalogue of built-in stream processors shipped with the server.

2 paths›

Bundles

Manage bundles — packaged collections of flows, processors, and configurations.

2 paths›

Entities

Manage entity definitions used across integrations.

2 paths›

Audit Logs

Retrieve immutable audit log entries recording changes to repository objects.

2 paths›

Entity Audit

Detailed per-entity audit history and diff comparison between two audit snapshots.

3 paths›

Config Panels

Manage config panel definitions that drive the UI configuration experience.

2 paths›

Resource Collections

Manage resource collections and the individual resources they contain.

5 paths›

Caches

Create and manage named caches used by flows at runtime.

2 paths›

Tokens

Create and manage API tokens for programmatic access.

2 paths›