Scan API Endpoint

This API endpoint allows users to submit a file or archive that will get converted into one or multiple (in the case of archives with multiple files) tasks. The list of accepted files for processing are returned in the "acceptedFiles" array, files with unsupported file type (or rejected for another reason, e.g. because they are too large) will be found in the "rejectedFiles" array. The call is asynchronous and will return immediately. Using the submission ID, the execution status and results can be retrieved later via the /submit-result or /task endpoints.

Syntax

POST https://<ip>:<port>/submit

Parameters

Example Response

Note: if a file gets rejected, appropriate data will be presented in the "rejectedFiles" array including a "rejectedReason" field.

Possible values for “rejectedReason”:

• EMPTY_FILE
• TOO_LARGE_FILE
• DIRECTORY
• ARCHIVE_UNPACKED
• ARCHIVE_INVALID
• ARCHIVE_ENCRYPTED
• ARCHIVE_ZIPBOMB
• INVALID_PASSWORD
• UNSUPPORTED_FILE_FORMAT
• SERVER_FULL
• INTERNAL_ERROR
• WHITELISTED

Transform Scan API Endpoint

This API endpoint allows users to submit a file that will get converted into one task. The call is asynchronous and will return immediately. Using the task ID, the execution status and results can be retrieved later via the /task endpoint.

Syntax

POST https://<ip>:<port>/scan

Example Response