Task API Endpoint

This API endpoint allows querying the reporting data returned by the underlying processor node. Based on an optional "all" parameter, a high-level or complete report can be retrieved. For convenience sake, the submission ID ("ID" as returned by /submit) or a combination of the processor node task ID ("taskID") and application server ID ("appServerID") must be provided. The "nocache" parameter is optional and determines whether cached reporting data (if available) may be returned or if the underlying processor node is to be re-queried.

Syntax

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

Parameters

NameTypeRequired?Description
serectStringYAuthentication secret
submitIDStringYSubmit ID as returned by /submit
appServerIDStringYMust be provided in combination with "taskID", if "submitID" is not provided
taskIDStringYMust be provided in combination with "appServer-ID", if "submitID" is not provided
allBooleanNReject submitted files, if their hash (MD5/SHA-256) is on an internal or external whitelist
nocacheBooleanNDisallow returning cached reporting data (if available). It is not recommended to set this flag, as the underlying processor nodes may clean up expired tasks triggering a 404 response code.

Example Response

JSON
Copy
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
Task API EndpointSyntaxParametersExample Response