getInputFileLog (File Filter)

Article Summary

Share feedback

Thanks for sharing your feedback!

Overview

The getInputFileLog API is a feature provided by "File Filter" in "File Safer" and is an API that checks the analysis result of the file requested for analysis using the inputFile API.
You can use this API through IAM authentication and API Gateway used in NAVER Cloud Platform.

Requests

Method	Request URI
GET	`https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog`

Request headers

Header name	Description
x-ncp-apigw-timestamp	Time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid
x-ncp-apigw-api-key	Key issued from API Gateway
x-ncp-iam-access-key	API Key issued from NAVER Cloud Platform or AccessKey issued from IAM
x-ncp-apigw-signature-v2	A signature that encrypts the request path and header with a SecretKey mapped to an AccessKey HMAC encryption algorithm uses HmacSHA256 See Call API that requires IAM authentication
accept	Indicate json. `application/json`

Request parameters

Parameter name	Requirement status	Type	Description
hash	Yes	string	Hash value to view
hashType	Yes	string	Algorithm type value with an extracted Hash to view and support md5, sha1 `sha1` or `md5`

Responses

Response bodies

Field name	Requirement status	Type	Description
returnCode	Yes	string	Processing result code for requests
returnMessage	Yes	string	Processing result message for requests
inputFileLogList	Yes	string	List of analysis results, displayed as a list if a file with the same Hash was analyzed more than 2 times
fileType	No	string	`Included only when there are analyzed files` Format notation of analyzed files
fileSize	No	int	`Included only when there are analyzed files` Size of analyzed files
md5	No	string	`Included only when there are analyzed files` MD5 Hash value of analyzed files
sha1	No	string	`Included only when there are analyzed files` SHA1 Hash value of analyzed files
sha256	No	string	`Included only when there are analyzed files` SHA256 Hash value of analyzed files
analysisStatusCode	No	string	`Included only when there are analyzed files` Analysis status code that has the following values [Code : Desc : Status] IPRG : Analyzing : Analyzing CMPL : Analysis completed : Analysis completed ERR : Analysis error : Error EXCN : Exclude analysis : Exception
analysisResultCode	No	string	`Included only when there are analyzed files` Analysis result code that has the following values [ Code : Desc : Status ] M : Malware detected : Malignant code (Update to Hash Filter) N : Malware not detected : Normal file E : Detection error : Error
notifyYmdt	No	long	`Included only when there are analyzed files` Time the notification was sent, if you set one
registrationYmdt	No	long	`Included only when there are analyzed files` Time the file came in
serviceCode	No	string or null	`Included only when there are analyzed files` Appears only for specific analytic requests and most often has a null value
applicationCode	No	string or null	`Included only when there are analyzed files` Appears only for specific analytic requests and most often has a null value

Examples

Request examples

curl -X GET "https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog?hash=f093e7767bb63ac973b697d3fd1d40a78b87b8bf&hashType=sha1"
   -H "accept: application/json"
   -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

Response examples (If an analyzed file exists)

{
  "returnCode": "0",
  "returnMessage": "success",
  "inputFileLogList": [
    {
      "fileType": "application/x-msdownload; format=pe32",
      "fileSize": 740544,
      "md5": "a69acb01b99959efec7c0a2a8caa7545",
      "sha1": "f093e7767bb63ac973b697d3fd1d40a78b87b8bf",
      "sha256": "470a75fe3da2ddf9d27fb3f9c96e6c665506ea7ba26ab89f0c89606f678ae4a2",
      "analysisStatusCode": "CMPL",
      "analysisResultCode": "M",
      "notifyYmdt": 1544005507000,
      "registrationYmdt": 1544005472000,
      "serviceCode": null,
      "applicationCode": null
    },
    {
      "fileType": "application/x-msdownload; format=pe32",
      "fileSize": 740544,
      "md5": "a69acb01b99959efec7c0a2a8caa7545",
      "sha1": "f093e7767bb63ac973b697d3fd1d40a78b87b8bf",
      "sha256": "470a75fe3da2ddf9d27fb3f9c96e6c665506ea7ba26ab89f0c89606f678ae4a2",
      "analysisStatusCode": "CMPL",
      "analysisResultCode": "M",
      "notifyYmdt": 1544006407000,
      "registrationYmdt": 1544006150000,
      "serviceCode": null,
      "applicationCode": null
    },
  ]
}

Response examples (If an analyzed file does not exist)

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

Was this article helpful?

What's Next

getInputFileLogByParentHash

Table of contents

Overview
Requests
Responses
Examples