File API Endpoint

This API endpoint allows downloading any processed or extracted (e.g. image embedded in a document) binary file. In order to retrieve a file, the SHA256 digest needs to be known. The reporting data as returned by /task will contain a variety of digests. The retrieved binary data is contained within the JSON response as a Base64 string. The decoded string is either the raw data or an inflated gzipped version (default). Using the "uncompressed" flag allows determining whether the decoded string is compressed or not.

Note: the "mediaType" returned is the media type of the underlying file.

Syntax

GET https://<ip>:<port>/file

Parameters

NameTypeRequired?Description
serectStringYAuthentication secret
sha256StringYSHA256 digest as found in the response of /submit or extracted resource in the reporting
uncompressedBooleanNDetermines whether the decoded Base64 data blob is gzip compressed or not. By default, the parameter is set to "false"

Example response

JSON
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard

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

On This Page
File API EndpointSyntaxParametersExample response