内容

概要

前提条件

要件

使用するコンポーネント

背景説明

設定

セーフリストのGETおよびPOST

GET

POST

ブロックリストのGETおよびPOST

GET

POST

関連情報

概要

このドキュメントでは、APIおよびcurlコマンドを使用してSecure Management Appliance(SMA)のセーフリスト/ブロックリスト(SL/BL)に送信者を追加する設定について説明します。

前提条件

要件

次の項目に関する知識があることが推奨されます。

- Secure Management Appliance(SMA)

- APIに関する知識

- スパム検疫に関する知識

- セーフリスト/ブロックリストの知識

使用するコンポーネント

このドキュメントの情報は、次のソフトウェアとハードウェアのバージョンに基づいています。

- Security Management Appliance(SMA)、AsyncOSバージョン12.0以降。

- クライアントまたはプログラミングライブラリのcURL。これは、APIからの応答を解釈するためにJSONをサポートする必要があります。

- AsyncOS APIにアクセスするための認可。

- 中央集中型のスパム検疫。

- セーフリストとブロックリストが有効になっています。

このドキュメントの情報は、特定のラボ環境にあるデバイスに基づいて作成されました。このドキュメントで使用するすべてのデバイスは、初期（デフォルト）設定の状態から起動しています。本稼働中のネットワークでは、各コマンドによって起こる可能性がある影響を十分確認してください。

背景説明

APIサービスの主な目的は、SMAからレポートと設定情報を取得することです。

スパム検疫からセーフリストおよびブロックリスト情報を取得したり、API cURLクエリを使用して新しいユーザを追加したりできます。

設定

セーフリストのGETおよびPOST

GET

このクエリーは、セーフリストから情報を取得します。この情報は、 sma1.example.com はSMAホスト名で、 adminはユーザ名です。

curl --location --request GET 'https://sma1.example.com/sma/api/v2.0/quarantine/safelist?action=view&quarantineType=spam&viewBy=recipient' -u admin

該当するユーザのパスワードを入力します。

出力は次のようになります。

{"meta": {"totalCount": 2}, "data": [{"senderList": ["example.com"], "recipientAddress": "user2@example.com"}, {"senderList": ["test.com"], "recipientAddress": "user2@test.com"}]}

GUIセーフリストは次の図のように表示されます。

GUIセーフリストの出力

POST

このクエリは、送信者の情報をセーフリストに追加します。 sma1.example.com はSMAホスト名で、 adminはユーザ名で、 user1@example.comは新しい受信者です。  example.com はセーフリストの送信者です。

curl --location --request POST 'https://sma1.example.com/sma/api/v2.0/quarantine/safelist' -u admin --data-raw '{

"action": "add",

"quarantineType": "spam",

"recipientAddresses": ["user1@example.com"],

"senderList": ["example.com"],

"viewBy": "recipient"

}'

このコマンドを実行し、対象のユーザのパスワードを入力します。

GUIセーフリストは次の図のように表示されます。

GUIセーフリストの出力

ブロックリストのGETおよびPOST

GET

このクエリは、セーフリストから情報を取得します。ここで、 sma1.example.com はSMAホスト名で、 adminはユーザ名です

curl --location --request GET 'https://sma1.example.com/sma/api/v2.0/quarantine/blocklist?action=view&quarantineType=spam&viewBy=recipient' -u admin

出力は次のようになります。

{"meta": {"totalCount": 2}, "data": [{"senderList": ["example1.com"], "recipientAddress": "user2@example.com"}, {"senderList": ["test1.com"], "recipientAddress": "user2@test.com"}]

GUIセーフリストは次の図のように表示されます。

GUIブロックリストの出力

POST

このクエリは、送信者の情報をセーフリストに追加します。 sma1.example.com はSMAホスト名で、 adminはユーザ名で、 user1@example.comは新しい受信者で、  example1.com はブロックリストの送信者です。

curl --location --request POST 'https://sma1.example.com/sma/api/v2.0/quarantine/blocklist' -u admin --data-raw '{

"action": "add",

"quarantineType": "spam",

"recipientAddresses": ["user1@example.com"],

"senderList": ["example1.com"],

"viewBy": "recipient"

}'

このコマンドを実行し、対象のユーザのパスワードを入力します。

GUIセーフリストは次の図のように表示されます。

GUIブロックリストの出力

関連情報

- プログラミングガイドSMA

- エンドユーザガイドSMA