MENU
      setNotiConfig

        setNotiConfig


        Article summary

        Available in Classic and VPC

        Set up notifications of analysis results using hash filter.

        Request

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

        MethodURI
        POST/setNotiConfig

        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:

        FieldTypeRequiredDescription
        notificationTypeStringRequiredConditions for analysis results notification
        • OFF | MAL | MAE | ERR | ALL
          • OFF: Do not notify
          • MAL: Notify when malware is detected
          • MAE: Notify when malware is detected or query fails
          • ERR: Notify when query fails
          • ALL: Notify all

        Request example

        The request example is as follows:

        curl --location --request POST 'https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig' \
        --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": "ALL"
        }'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        returnCodeStringRequiredResponse code
        returnMessageStringRequiredResponse 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"
        }
        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.