セキュアエンドポイントAPIの概要
問題
このドキュメントでは、Cisco Secure Endpoints(SE)APIの使用方法について説明します。
解決方法
SE APIを使用するには、SEコンソールでAPIクレデンシャルを作成します。
この記事の例では、Windows 7エンドポイントを使用しています。
1. コンソールにログインし、Accounts > API Credentialsの順に選択します。
1. [New API Credential]をクリックして、新しいキーのセットを作成します。
2. 「アプリケーション名」を入力します。[Scope] で [Read-only] または [Read & Write] を選択します。
3. 「作成」ボタンをクリックします。API Key Detailsページが表示されます。この情報の一部は画面を終了した後に使用できないため、保存してください。
アプリケーションの API クレデンシャルが漏えいした疑いがある場合、その API クレデンシャルを削除し、新しい API クレデンシャルを作成します。 APIクレデンシャルを削除すると、古いクレデンシャルを使用しているクライアントがロックアウトされるため、新しいクレデンシャルで更新します。
環境
- テスト済みエンドポイント:Windows 7エンドポイント。
- 製品:Cisco SE
- アクセス:APIクレデンシャルを作成および削除する権限を持つコンソールアクセス。
- API:SE APIバージョン3、バージョン1、バージョン0（例ではバージョン1を使用）。
- クライアントツール:API要求の実行に使用されるシステムにインストールされたcurl。
現在、SE APIには、バージョン3、バージョン1、バージョン0の3つのバージョンがあります。 バージョン3では、バージョン1およびバージョン0に比べて追加機能が提供されます。バージョン3 APIのドキュメントは、このリンクから入手できます。 この情報を取得するには、バージョン3を使用します。
- 監査ログ
- デバイス制御
- デバイス
- 除外
- ホストファイアウォール
- IOC
- MSSP
- 組織
- ポリシー
- コンピュータ
- 脆弱性
ドキュメント内の該当するコマンドをクリックすると、その使用例が表示されます。
API コマンドの詳細および例
各APIコマンドには同様の情報が含まれ、curlコマンドに分割すると次のようになります。
curl -o yourfilename.json https://client_id:api_key@api.example.com/v1/whatyouwanttodo-oオプションを指定してcurlコマンドを使用すると、出力をファイルに保存できます。この場合、ファイル名は「yourfilename.json」です。
curlコマンドの次の部分では、@記号の前にクレデンシャルを指定します。APIクレデンシャルを生成した後、URLのこの部分でAPIクライアントIDとAPIキーを使用します。
https://client_id:api_key@実行するバージョン番号とアクションを追加します。この例では、GET /v1/computersを実行します。完全なコマンドは次のようになります。
curl -o computers.json https://client_id:api_key@api.example.com/v1/computersコマンドを実行すると、コマンドを開始したディレクトリにcomputers.jsonファイルが表示されます。
ファイルを開くと、すべてのデータが1行に表示されます。フォーマットされたレイアウトで表示するには、JSONをフォーマットするブラウザプラグインをインストールし、ファイルをブラウザで開きます。この出力には、次のようなコンピュータの情報が表示されます。
connector_guid、hostname、active、links、connector_version、operating_system、internal_ips、external_ip、group_guid、network_addresses、policy guid、policy name。
{
version: "v1.0.0",
metadata: {
links: {
self: "https://api.amp.cisco.com/v1/computers"
},
results: {
total: 4,
current_item_count: 4,
index: 0,
items_per_page: 500
}
},
data: [
{
connector_guid: "abcdef-1234-5678-9abc-def123456789",
hostname: "host.example.com",
active: true,
links: {
computer: "https://api.amp.cisco.com/v1/computers/abcdef-1234-5678-9abc-def123456789",
trajectory: "https://api.amp.cisco.com/v1/computers/abcdef-1234-5678-9abc-def123456789/trajectory",
group: "https://api.amp.cisco.com/v1/groups/abcdef-1234-5678-9abc-def123456789"
},
connector_version: "4.4.2.10200",
operating_system: "Windows 7, SP 1.0",
internal_ips: [
"10.1.1.2",
" 192.168.1.2",
" 192.168.2.2",
" 169.254.245.1"
],
external_ip: "192.0.2.10",
group_guid: "abcdef-1234-5678-9abc-def123456789",
network_addresses: [
{
mac: "ab:cd:ef:01:23:45",
ip: "10.1.1.2"
},
{
mac: "bc:de:f0:12:34:56",
ip: "192.168.1.2"
},
{
mac: "cd:ef:01:23:45:67",
ip: "192.168.2.2"
},
{
mac: "de:f0:12:34:56:78",
ip: "169.254.245.1"
}
],
policy: {
guid: "abcdef-1234-5678-9abc-def123456789",
name: "Protect Policy"
}
}
]
}
次の例は、基本的なAPI要求を示しています。他のコマンドオプションを使用して、環境内のデータを取得および変更できるようになりました。
関連コンテンツ
- Cisco AMP for Endpoints API のドキュメンテーション
- テクニカル サポートとドキュメント – Cisco Systems
更新履歴
| 改定 | 発行日 | コメント |
|---|---|---|
2.0 |
26-Oct-2026
|
再認定 |
1.0 |
20-Mar-2017
|
初版 |
フィードバック