setNotiConfig

Prev Next

Classic/VPC環境で利用できます。

File Filterを使用した分析結果の通知を設定します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /setNotiConfig

リクエストヘッダ

File Safer APIで共通して使用されるヘッダの詳細は、File Safer APIの共通ヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
notificationType String Required 分析結果の通知条件
  • OFF | MAL | MAE | ERR | ALL
    • OFF: 通知しない
    • MAL: マルウェア検出時、通知
    • MAE: マルウェアを検出または照会失敗時、通知
    • ERR: 照会失敗時、通知
    • ALL: すべて通知

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--data '{
    "notificationType": "ALL"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
returnCode String Required レスポンスコード
returnMessage String Required レスポンスメッセージ

レスポンスステータスコード

File Safer APIで共通して使用されるレスポンスステータスコードの詳細は、File Saferのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "returnCode": "0",
    "returnMessage": "success"
}