setNotiConfig (Hash Filter/File Filter)
- Print
- PDF
setNotiConfig (Hash Filter/File Filter)
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
- setNotiConfig API is provided by the "Hash Filter" of "File Safer" that sets conditions for analysis result notifications.
- The API request must be IAM-authenticated via API Gateway.
Request Hash Filter
| Method | Request URI |
|---|---|
| POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig |
Request File Filter
| Method | Request URI |
|---|---|
| POST | https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig |
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. |
Request Body
{
"notificationType": "type"
}
| Parameter | Required | Type | Description |
|---|---|---|---|
| notificationType | Yes | string | You can select a value to set conditions for notifications: OFF, MAL, MAE, ERR, or ALL. - OFF : Do not notify - MAL : Notify when malicious code is detected. - MAE : Notify when malware detection or lookup fails. - ERR : Notify when a query fails. - ALL : Notify everyone. |
Response
Response body (Hash Filter, File Filter)
| Field | Required | Type | Description |
|---|---|---|---|
| returnCode | Yes | string | Response code |
| returnMessage | Yes | string | Response message |
Example
Example of requesting setting for Hash Filter result notifications
curl -X GET "https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig"
-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}"
-d {"notificationType":{notificationType}}
Example of requesting setting for File Filter result notifications
curl -X GET "https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig"
-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}"
-d {"notificationType":{notificationType}}
Response example (When setting result notifications is successful)
{
"returnCode": "0",
"returnMessage": "success"
}
Was this article helpful?