Title	Process one or more files from Box
URL Path	/api/file/process/box
Method	POST

Summary

Download individual files from a storage for processing with MetaDefender technologies. For example, a third-party application detects newly uploaded files to Box and sends them to MetaDefender for Secure Storage.
note

A newly added or modified file is not immediately available for processing. It may take up to 10 minutes for it to be fully indexed and ready to be searched.

HTTP Headers

Authorization	required	Bearer <JWT>

Sample HTTP body

{
  "StorageName": "My Storage",
  "FilterType": 0,
  "Items": [
    {
      "FilePath": "test/picture.jpeg",
      "UserName": "user1"
    }
  ]
}

Description of request

StorageName	The name of the storage unit containing the files	string value
FilterType	Type of filter	Possible values: 0 - ByPath
Items	Array of objects that contain information about the file	array of objects
Items[].FilePath	The full path of the file	string value
Items[].UserName	The username of the owner of the file	string value

Request errors

400 Bad Request	Invalid HTTP request
401 Unauthorized	Unauthorized HTTP request
404 Not Found	The requested resource could not be found
500 Internal Server Error	Server is temporarily unavailable

Response

Example of a successful request:

{
    "FileIds": [
        "5d7a33198b0a56f2b9c3dbb3",
        "5d7a33198b0a56f2b9c3dbb4"
    ],
    "ResponseKey": "STARTED_PROCESSING_FILE",
    "ResponseMessage": "Started processing file"
}

Description of response

FileIds	Array of unique file identifiers	A list of generated IDs for the requested files that can be used to query results at a later time
ResponseKey	Response message key	A message key that can be used for internalization
ResponseMessage	Response message	A message describing the result of the request

5.2.3 Process one or more files from Box