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 Fail Safer service provides APIs for the hash filter and file filter features in a RESTful format.
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:
https://filesafer.apigw.ntruss.com
Request headers
The following describes the request headers:
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued from NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature generated by encrypting the request information with the secret key mapped to the access key, using the HmacSHA256 algorithm
|
Accept |
Required | Response 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 information about the 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 Filter
The APIs related to file filter are as follows:
| API | Description |
|---|---|
| getInputFileLog | Get analytics results for files sent with the InputFile API. |
| getInputFileLogByParentHash | Get analysis results for files in a compressed file sent with the InputFile API. |
| getNotiConfig | Get notification settings for analytics results. |
| getThresholdNotiConfig | Get advanced notification settings for analytics results. |
| InputFile | Send files to analyze with file filter. |
| 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: Learn how to issue and view the access key and secret key from NAVER Cloud Platform, and how to create the signature required for request headers.
- Sub Account user guide: Learn how to issue and view access keys for sub accounts in 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: Learn how to use the File Safer service in the NAVER Cloud Platform console.
- Ncloud user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Latest announcements: tay informed about File Safer service updates and news.
- FAQs: Get answers to common File Safer questions.
- Contact Us: Send direct inquiries for unresolved questions that aren't answered by the API guide.