FileUDSO :: Add

Adds a suspicious file object to the Control Manager user-defined suspicious object list.

HTTP Request

PUT /WebApp/API/SuspiciousObjectResource/FileUDSO

Parameters

Important:

The HTTP request body must contain the 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 and request body:

  • HTTP header:

    Header

    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 200 OK status code and a response body with 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

API Sequence Diagram