setThresholdNotiConfig

Prev Next

Available in Classic and VPC

Set the value of advanced settings in the notification settings for analysis results using file filter. Advanced settings are features that notify you when a threshold amount of malware is detected over a period of time.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /setThresholdNotiConfig

Request headers

For information about the headers common to all File Safer APIs, see Common File Safer API headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
notificationType String Required Conditions for analysis results notification
  • MAL | ERR
    • MAL: Notify when malware is detected.
    • ERR: Notify when query fails.
referenceTime Integer Required Time to detect malware that meets the threshold (minutes)
  • 5-30
  • Can be set in increments of 5 minutes.
thresholdValue Integer Required Threshold (cases)
  • 1-1000

Request example

The request example is as follows:

curl --location --request POST 'https://filesafer.apigw.ntruss.com/filefilter/v1/setThresholdNotiConfig' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--data '{
    "notificationType": "ERR",
    "referenceTime": 5,
    "thresholdValue": 1
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
returnCode String Required Response code
returnMessage String Required Response message

Response status codes

For information about the HTTP status codes common to all File Safer APIs, see File Safer response status codes.

Response example

The response example is as follows:

{
    "returnCode": "0",
    "returnMessage": "success"
}