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
Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| serect | String | Y | Authentication secret |
| password | String | N | Archive password |
| priority | Integer | N | Processing priority (0 = default, 100 = highest) |
| transformOpt.[option] | String | N | See fsBroker API Documentation foravailable options |
| $_FILE | Octet-Stream | Y | File/Archive as form-data body |
Example Response
{ "processTime": 899, "scanTasks": [ { "taskReference": { "name": "transform-file", "additionalInfo": { "submitName": "file", "digests": { "SHA-256": "99f8505240fff0831382ddf692f83750844887047ef90f59034d34d857271608" }, "callbackDeleteAfter": false }, "ID": "1fd6d36c-5909-498e-9351-ba8080e5c530", "state": "IN_PROGRESS", "opcount": 0, "processTime": 0 }, "opcount": 0, "processTime": 0, "taskWarnings": [], "allTags": [], "allSignalGroups": [], "resources": {} } ]}Was this page helpful?