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

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

CodeDefinition
200Successful
204Successful, but no content
400Bad Request
404File Not Found
500Internal Server Error
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
File API Endpoint

See the "Technical Datasheet" for a complete list of features: https://docs.opswat.com/filescan/datasheet/technical-datasheet

On This Page
SpecificationAPI workflowHTTP Default ConfigurationHTTP Response Codes