Adds a suspicious file object to the User-Defined Suspicious Object list.
HTTP Request
PUT /WebApp/API/SuspiciousObjectResource/FileUDSO
Parameters
The HTTP request body must contain all required parameters.
Name |
Type |
Description |
---|---|---|
Required Parameters |
||
file_name |
String |
The name of the suspicious file to upload |
file_content_base64_string |
String |
The binary content of the suspicious file, converted to a base64 string |
file_scan_action |
String |
The scan action to perform on the suspicious file
|
note |
String |
Additional information about the suspicious file |
HTTP Request Example
PUT /WebApp/API/SuspiciousObjectResource/FileUDSO
HTTP Request Body
Specify a JSON object containing the following:
-
HTTP header:
Field Name
Value
Authorization
Bearer [Generated JWT authentication token]
-
Request body:
{ "file_name":"VerySmallFile.txt", "file_content_base64_string":"MTIzMTIz", "file_scan_action":"LOG", "note":"Small file for test" }
Response
If successful, this method returns an HTTP status code of "200" and a response body with a result code of "1" and the following structure:
{ "result_code":1 "result_description":"Operation successful" "result_content":null }
If unsuccessful, this method returns the following result codes:
Result Code |
Description |
---|---|
-1101 |
Suspicious object action unsuccessful: Maximum quantity exceeded |
-1102 |
Suspicious object action unsuccessful: Unable to generate Scan Prefilter for uploaded file, file likely to be blocked by antivirus |
For more information about API responses and descriptions of response codes, see the following topics:
API Sequence Diagram
