getThresholdNotiConfig

Prev Next

Available in Classic and VPC

Get 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 /getThresholdNotiConfig

Request headers

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

Request example

The request example is as follows:

curl --location --request POST 'https://filesafer.apigw.ntruss.com/filefilter/v1/getThresholdNotiConfig' \
--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'

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
thresholdNotificationInfoList[] Array Required Notification setting information for analysis results
  • If the object exists: Set up notifications
  • If no object exists: Do not set up notifications
thresholdNotificationInfoList[].notificationType String Conditional Conditions for analysis results notification
  • MAL | ERR
    • MAL: Notify when malware is detected
    • ERR: Notify when query fails
  • Include only if you have advanced settings within notification settings
thresholdNotificationInfoList[].referenceTime Integer Conditional Time to detect malware that meets the threshold (minute)
  • 5 - 30
  • Include only if you have advanced settings within notification settings
thresholdNotificationInfoList[].thresholdValue Integer Conditional Threshold (case)
  • 1 - 1000
  • Include only if you have advanced settings within notification settings

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:

If advanced settings are enabled

The following is a sample response if you have advanced settings in the notification settings for analysis results.

{
    "returnCode": "0",
    "returnMessage": "success",
    "thresholdNotificationInfoList": [
        {
            "notificationType": "MAL",
            "referenceTime": 5,
            "thresholdValue": 1
        }
    ]
}

If advanced settings are disabled

The following is a sample response if you don't have advanced settings in the notification settings for analysis results.

{
    "returnCode": "0",
    "returnMessage": "success",
    "thresholdNotificationInfoList": [
    ]
}