Introduction

What is fsBroker?

The OPSWAT Filescan Broker ("fsBroker") receives and redistributes files for processing by one or multiple underlying application processor nodes (referred to as "fsTransform"). The broker processes files either via the exposed API or from configurable file system pathways. Please refer to the user guide for more information on the setup and configuration. The following diagram gives an idea of where the broker is situated within the overall system architecture:

System Architecture

Note: the API presented in this document is the same as used by the Web Backend of the community webservice. Thus, it can also be used programmatically by other implementations.

What is the fsBroker API?

The fsBroker API is a simple HTTP based programmatic interface that allows submission of files and archives, which will be processed and redistributed to a group of processor nodes ("fsTransform", see above). Under the hood, the broker uses a file system-based priority queue and stores all received binary files in a central binary storage, which are also available via the API. All API requests require authentication via a configurable secret and authorization levels. In the following, the most important API endpoints are presented.

What is fsTransform?

The OPSWAT Filescan Transformer ("fsTransform") can process a single file (for archive support, see "fsBroker") specified either via the exposed API or from the file system as specified per the command line. Please refer to the user guide for more information on the setup and configuration. The following diagram gives an idea of where the transform processor node(s) are situated within the overall system architecture:

What is the fsTransform API?

System Architecture

The fsTransform API is a simple HTTP based programmatic interface that allows submission of files, which will undertake deep static analysis and transformed into a reporting. All API requests require authentication via a configurable secret and authorization levels. In the following, the most important API endpoints are presented.