FireFlow REST web services

This section describes the FireFlow REST web services APIs.

Base URL

The base URL for all REST requests is the following:


where <algosec_server> is the AFA/FireFlow server URL.

Note: Every request must be in JSON format. Each request must include the content-type header with the value application/json.

Back to top

Header requirements in FireFlow

The header requirement for all REST requests is:

Header requirements:

Key Value
Cookie FireFlow_Session=[sessionID]. The sessionId is retrieved from the authentication request.

Back to top


The FireFlow RESTful API includes Swagger support, enabling you to execute simplified API request calls and access full lists of request parameters.

To access Swagger API documentation:

  1. In the toolbar, click your username and click API Documentation.
  2. From the dropdown at the top-right, click AlgoSec_FireFlow.

Back to top

FireFlow REST API reference

FireFlow supports the following REST APIs:

For more details, see FireFlow data types.

Back to top