Specification

API workflow

The following diagram outlines a typical API workflow / use case for submitting a file / archive and retrieving the reporting and/or extracted binary files.

Typical API Workflow

HTTP Default Configuration

For the API to become available, the broker needs to be launched with "listenMode" enabled. The HTTP port at which the API will become available is configurable via the "listenServerPort" option. The default port is 23001.

HTTP Response Codes