getThresholdNotiConfig (Hash Filter/File Filter)
- Print
- PDF
getThresholdNotiConfig (Hash Filter/File Filter)
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
- The getThresholdNotiConfig API is a feature provided by "Hash Filter" and "File Filter" in "File Safer" and an API that checks the set values of advanced setting (threshold settings) within the Set results notification.
- You can use this API through IAM authentication and API Gateway used in NAVER Cloud Platform.
Hash Filter request
| Method | Request URI |
|---|---|
| POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/getThresholdNotiConfig |
File Filter request
| Method | Request URI |
|---|---|
| POST | https://filesafer.apigw.ntruss.com/filefilter/v1/getThresholdNotiConfig |
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | Time elapsed in milliseconds 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 |
| accept | Indicate jsonapplication/json |
Responses
Response bodies (same for Hash Filter and File Filter)
| Field name | Required | Type | Description |
|---|---|---|---|
| returnCode | Yes | string | Processing result code for requests |
| returnMessage | Yes | string | Processing result message for requests |
| thresholdNotificationInfoList | Yes | List | - Information on analysis result notification value - When there's an object in list: analysis result notification setting - If there's no object in list: analysis result notification not set |
| notificationType | Yes | string | Only included when analysis result notification is set Analysis result notification value |
| referenceTime | Yes | integer | Only included when analysis result notification is set - Time setting (minute) value Can be set in 5 minute increments with values from 5 to 30 |
| thresholdValue | Yes | integer | Only included when Analysis result notification is set - Threshold setting value Threshold can be set to a value of 1 to 1000 |
Examples
Request examples of Hash Filter set result notification
curl -X POST "https://filesafer.apigw.ntruss.com/hashfilter/v1/getThresholdNotiConfig"
-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}"
Request examples of File Filter set result notification
curl -X POST "https://filesafer.apigw.ntruss.com/filefilter/v1/getThresholdNotiConfig"
-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
{
"returnCode": "0",
"returnMessage": "success",
"thresholdNotificationInfoList": [
"notificationType": "MAL",
"referenceTime": 5,
"thresholdValue": 1
]
}
Was this article helpful?