getNotiConfig (Hash Filter/File Filter)
- Print
- PDF
getNotiConfig (Hash Filter/File Filter)
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
- getNotiConfig API is provided by the "Hash Filter" and "File Filter" of "File Safer" that checks condition settings for notification of analysis results.
- The API request must be IAM-authenticated via API Gateway.
Request Hash Filter
| Method | Request URI |
|---|---|
| GET | https://filesafer.apigw.ntruss.com/hashfilter/v1/getNotiConfig |
Request File Filter
| Method | Request URI |
|---|---|
| GET | https://filesafer.apigw.ntruss.com/filefilter/v1/getNotiConfig |
Request Header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid. |
| x-ncp-apigw-api-key | API key issued by API Gateway |
| x-ncp-iam-access-key | API key issued by NAVER Cloud Platform or access key issued by IAM |
| x-ncp-apigw-signature-v2 | Signature used to encrypt the body with the “secret key” that maps with the “access key.” The HMAC encryption algorithm is HMAC SHA256. Reference Call APIs that require IAM authentication |
| accept | Specify application/json. |
Response
Response body (Hash Filter, File Filter)
| Field | Required | Type | Description |
|---|---|---|---|
| returnCode | Yes | string | Response code |
| returnMessage | Yes | string | Response message |
| notificationType | Yes | string | Setting value of notification of analysis results |
Example
Example of requesting checking for Hash Filter result notifications
curl -X GET "https://filesafer.apigw.ntruss.com/hashfilter/v1/getNotiConfig"
-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}"
Example of requesting checking for Hash Filter result notifications
curl -X GET "https://filesafer.apigw.ntruss.com/filefilter/v1/getNotiConfig"
-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 example (If Notify everyone is set)
{
"returnCode": "0",
"returnMessage": "success",
"notificationType": "ALL"
}
Was this article helpful?