File Safer overview
- Print
- PDF
File Safer overview
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
The File Safer API is provided in a RESTful format, and to call the provided API, you must perform IAM authentication through the API Gateway.
Common settings
IAM authentication
As the File Safer API is provided through the API Gateway, subscription and an API key are required for the IAM authentication necessary when using the API Gateway.
Subscribes to the API Gateway service. (Introduction to API Gateway)
Go to the API Keys menu of the API Gateway and create an API key. (Create an API key)
As the subscription type of the File Safer API is Public, you can use it with the API key you created without a separate subscription process.
API
| Service | API | Method | Request URI |
|---|---|---|---|
| Hash Filter | checkHash | GET | https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash |
| Hash Filter | getNotiConfig | GET | https://filesafer.apigw.ntruss.com/hashfilter/v1/getNotiConfig |
| Hash Filter | setNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig |
| Hash Filter | getThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/getThresholdNotiConfig |
| Hash Filter | setThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/setThresholdNotiConfig |
| Hash Filter | removeThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/removeThresholdNotiConfig |
| File Filter | inputFile | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/inputFile |
| File Filter | getInputFileLog | GET | https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog |
| File Filter | getInputFileLogByParentHash | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLogByParentHash |
| File Filter | getNotiConfig | GET | https://filesafer.apigw.ntruss.com/filefilter/v1/getNotiConfig |
| File Filter | setNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig |
| File Filter | getThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/getThresholdNotiConfig |
| File Filter | setThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/setThresholdNotiConfig |
| File Filter | removeThresholdNotiConfig | POST | https://filesafer.apigw.ntruss.com/filefilter/v1/removeThresholdNotiConfig |
Request headers
The following are the request headers for IAM authentication.
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 (UTC). The request is considered invalid if the time difference compared to the API Gateway server is more than 5 minutes |
| x-ncp-apigw-api-key | Key issued from API Gateway |
| x-ncp-iam-access-key | The 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 HmacSHA256 is used as the HMAC encryption algorithm. Refer to Call API that requires IAM authentication |
Errors
| HTTP response code | returnCode | returnMessage |
|---|---|---|
| 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 |
Common errors
| HTTP response code | ErrorCode | ErrorMessage |
|---|---|---|
| 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 |
Was this article helpful?