了解安全终端API概述
问题
本文档介绍思科安全终端(SE)API使用情况。
分辨率
要使用SE API，请在SE控制台中创建API凭证。
本文中的示例使用Windows 7终端。
1.登录到控制台并导航到帐户> API凭证。
1.单击New API Credential以创建一组新的密钥。
2.输入应用程序名称。选择Scope（只读范围）或Read & Write（读写）。
3.单击创建按钮。系统将显示API Key Details页面。保存此信息，因为某些信息在离开屏幕后不可用。
如果您怀疑某个应用的API凭证受到危害，请将其删除，并创建一个新凭证。 删除API凭证时，它会锁定使用旧凭证的客户端，因此使用新凭证更新它们。
环境
- 测试的终端：Windows 7终结点。
- 产品:思科SE
- 接入:具有创建和删除API凭证权限的控制台访问。
- API:SE API版本3、版本1和版本0（示例使用版本1）。
- 客户端工具:系统上安装的curl，用于运行API请求。
SE API目前有三个版本：版本3、版本1和版本0。与版本1和版本0相比，版本3提供其他功能。版本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文件会出现在发出该命令的目录中。
打开文件时，所有数据都显示在一行上。要在格式化布局中查看该文件，请安装一个格式为JSON的浏览器插件，然后在浏览器中打开该文件。此输出显示计算机的信息，例如：
connector_guid、hostname、active、links、connector_version、operating_system、internal_ips、external_ip、group_guid、network_addresses、policy guid和策略名称。
{
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请求。现在，您可以使用其他命令选项来检索和修改环境中的数据。
相关内容
- 面向终端的思科AMP API文档
- 技术支持和文档 - Cisco Systems
修订历史记录
| 版本 | 发布日期 | 备注 |
|---|---|---|
2.0 |
26-Oct-2026
|
重新认证 |
1.0 |
20-Mar-2017
|
初始版本 |
反馈