MENU
      getThresholdNotiConfig

        getThresholdNotiConfig


        Article summary

        Available in Classic and VPC

        Get the value of advanced settings in the notification settings for analysis results using hash 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:

        MethodURI
        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/hashfilter/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'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        returnCodeStringRequiredResponse code
        returnMessageStringRequiredResponse message
        thresholdNotificationInfoList[]ArrayRequiredNotification setting information for analysis results
        • If the object exists: Set up notifications
        • If no object exists: Do not set up notifications
        thresholdNotificationInfoList[].notificationTypeStringConditionalConditions 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[].referenceTimeIntegerConditionalTime to detect malware that meets the threshold (minute)
        • 5 - 30
        • Include only if you have advanced settings within notification settings
        thresholdNotificationInfoList[].thresholdValueIntegerConditionalThreshold (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
                }
            ]
        }
        JSON

        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": [
            ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.