MENU
      File Safer overview
        • PDF

        File Safer overview

        • PDF

        Article summary

        Available in Classic and VPC

        File Safer is a NAVER Cloud Platform service that helps you scan files and outlinks served over the web for malicious code. The File Safer service provides APIs for hash filter and file filter features in the form of RESTful.

        Common File Safer settings

        The following describes commonly used request and response formats in File Safer APIs.

        Request

        The following describes the common request format.

        API URL

        The request API URL is as follows.

        Hash Filter: https://filesafer.apigw.ntruss.com/hashfilter/v1
        File Filter: https://filesafer.apigw.ntruss.com/filefilter/v1
        HTTP

        Request headers

        The following describes the request headers.

        FieldRequiredDescription
        x-ncp-apigw-timestampRequiredThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC
      • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
      • x-ncp-apigw-api-keyRequiredAPI key issued by API Gateway of NAVER Cloud Platform
        x-ncp-iam-access-keyRequiredAccess key issued on NAVER Cloud Platform
      • Issue and check access key: See Create authentication key
      • Issue and check access key for sub account: See Create sub account
      • x-ncp-apigw-signature-v2RequiredBase64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
      • Issue and check secret key: See Create authentication key
      • Create signature: See Create signature
      • AcceptRequiredResponse data format
      • application/json
      • Response

        The following describes the common response format.

        Response status codes

        The following describes response status codes.

        HTTP status codeCodeMessage
        2000success
        200140000Unknown Error
        200140001Parameter is invalid
        200140002Not existent user
        200140003Already in use
        200140004Not allowed user
        200140005Not existing the required parameter
        200140006invalid request
        200140007file size exceeds the limit
        200140009Input file has a problem
        200140010Unzip failed
        400100Bad Request Exception
        401200Authentication Failed
        401210Permission Denied
        404300Not Found Exception
        429400Quota Exceeded
        429410Throttle Limited
        429420Rate Limited
        413430Request Entity Too Large
        503500Endpoint Error
        504510Endpoint Timeout
        500900Unexpected Error
        Note

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        File Safer API

        The following describes the APIs provided by the File Safer service.

        Hash Filter

        The APIs related to hash filter are as follows.

        APIDescription
        checkHashDetermine if a file or URL string is malicious
        getNotiConfigGet notification settings for analytics results
        getThresholdNotiConfigGet advanced notification settings for analytics results
        removeThresholdNotiConfigDelete advanced notification settings for analytics results
        setNotiConfigSet up notifications for analytics results
        setThresholdNotiConfigSet up advanced notifications for analytics results

        File Filter

        The APIs related to file filter are as follows.

        APIDescription
        getInputFileLogGet analytics results for files sent with the InputFile API
        getInputFileLogByParentHashGet analysis results for files in a compressed file sent with the InputFile API
        getNotiConfigGet notification settings for analytics results
        getThresholdNotiConfigGet advanced notification settings for analytics results
        InputFileSend files to analyze with file filter
        removeThresholdNotiConfigDelete advanced notification settings for analytics results
        setNotiConfigSet up notifications for analytics results
        setThresholdNotiConfigSet up advanced notifications for analytics results

        NAVER Cloud Platform provides a variety of related resources to help users better understand File Safer APIs.


        Was this article helpful?

        What's Next
        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.