- Print
- PDF
File Safer overview
- Print
- PDF
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
Request headers
The following describes the request headers.
Field | Required | Description |
---|---|---|
x-ncp-apigw-timestamp | Required | It indicates the elapsed time in milliseconds since January 1, 1970 00:00:00 UTC |
x-ncp-apigw-api-key | API key issued by NAVER Cloud Platform's API Gateway | |
x-ncp-iam-access-key | Required | Access key issued on NAVER Cloud Platform |
x-ncp-apigw-signature-v2 | Required | Base64-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) |
Accept | Required | Request data formatapplication/json |
Response
The following describes the common response format.
Response status codes
The following describes response status codes.
HTTP status code | Code | Message |
---|---|---|
200 | 0 | success |
200 | 140000 | Unknown Error |
200 | 140001 | Parameter is invalid |
200 | 140002 | Not existent user |
200 | 140003 | Already in use |
200 | 140004 | Not allowed user |
200 | 140005 | Not existing the required parameter |
200 | 140006 | invalid request |
200 | 140007 | file size exceeds the limit |
200 | 140009 | Input file has a problem |
200 | 140010 | Unzip failed |
400 | 100 | Bad Request Exception |
401 | 200 | Authentication Failed |
401 | 210 | Permission Denied |
404 | 300 | Not Found Exception |
429 | 400 | Quota Exceeded |
429 | 410 | Throttle Limited |
429 | 420 | Rate Limited |
413 | 430 | Request Entity Too Large |
503 | 500 | Endpoint Error |
504 | 510 | Endpoint Timeout |
500 | 900 | Unexpected Error |
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.
API | Description |
---|---|
checkHash | Determine if a file or URL string is malicious |
getNotiConfig | Get notification settings for analytics results |
getThresholdNotiConfig | Get advanced notification settings for analytics results |
removeThresholdNotiConfig | Delete advanced notification settings for analytics results |
setNotiConfig | Set up notifications for analytics results |
setThresholdNotiConfig | Set up advanced notifications for analytics results |
File Safer related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand File Safer APIs.
- File Safer API guides
- API overview: how to issue and check access key and secret key issued by NAVER Cloud Platform, how to generate the signature required for request headers
- Sub Account User Guide: how to issue and check access keys for sub accounts issued by NAVER Cloud Platform
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by File Safer
- How to use the File Safer service
- File Safer User Guide: how to use the File Safer service in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: summary of File Safer pricing system, characteristics, and detailed features
- Latest service news: the latest news on the File Safer service
- FAQ: frequently asked questions from File Safer users
- Contact us: Send direct inquiries for unresolved questions that aren't answered by the API guide.