使用安全访问API通过Curl管理目标列表

简介

本文档介绍如何通过安全访问API的curl管理目标列表。

先决条件

要求

Cisco 建议您了解以下主题：

• 安全访问
• 安全访问API
• 卷曲
• Json

使用的组件

本文档中的信息基于以下软件和硬件版本：

• 安全访问
• 安全访问API
• 卷曲
• Json

本文档中的信息都是基于特定实验室环境中的设备编写的。本文档中使用的所有设备最初均采用原始（默认）配置。如果您的网络处于活动状态，请确保您了解所有命令的潜在影响。

配置

1. 创建API密钥 

导航到安全访问控制面板。

• 点击 Admin > Api Keys > Add


创建API密钥1创建API密钥2

• 根据需要添加所需的API Key Name、Description (Optional)Expiry Date

创建API密钥3

• 在 Key Scope下，选择Policies，然后选择Expand policies 
• 选择Destination Lists， Destinations
• 如有需要，请更改Scope，否则保留为 Read/Write
• 点击 CREATE KEY

创建API密钥4

• 复制API Key和 Key Secret ，然后单击 ACCEPT AND CLOSE

  

创建API密钥5

2. 生成API访问令牌

要生成API访问令牌，请发出令牌授权请求：

令牌授权请求

使用您为组织创建的安全访问API凭证生成API访问令牌。

• 在curl示例中，替换您的安全访问API密钥和密钥

curl --user key:secret --request POST --url https://api.sse.cisco.com/auth/v2/token -H Content-Type: application/x-www-form-urlencoded -d grant_type=client_credentials

• 复制并保存生成的承载API令牌

3. 管理目标列表

管理目标列表的方法有多种，包括：

获取所有目标列表

打开windows命令提示符或Mac terminal以运行命令：

curl -L --location-trusted --request GET --url https://api.sse.cisco.com/policies/v2/destinationlists -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json"

示例输出中的代码段：

{"id":23456789,"organizationId":1234567,"access":"none","isGlobal":false,"name":" Test Block list","thirdpartyCategoryId":null,"createdAt":1694070823,"modifiedAt":1702819637,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":2,"meta": {"destinationCount":2,"domainCount":2,"urlCount":0,"ipv4Count":0,"applicationCount":0}

记录输出中“id”字段下列出的destinationListId，该字段进一步用于此目标列表特定的GET、POST或DELETE请求。

获取目标列表中的所有目标


• 使用上述提及步骤获取destinationListId，获取所有目标列表

打开windows命令提示符或Mac terminal以运行命令：

curl -L --location-trusted --request GET --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId/destinations -H "Authorization: Bearer YourAccessToken" 

 输出示例：

{"status":{"code":200,"text":"OK"},"meta":{"page":1,"limit":100,"total":3},"data": [ {"id":"415214","destination":"cisco.com","type":"domain","comment":null,"createdAt":"2024-02-20 09:15:46"},{"id":"7237895","destination":"www.cisco.com","type":"domain","comment":null,"createdAt":"2024-02-20 10:19:51"},{"id":"29275814","destination":"10.10.10.10","type":"ipv4","comment":null,"createdAt":"2024-02-20 09:15:46"},{"id":"71918495","destination":"www.subdomain.cisco.com/resoucre","type":"url","comment":null,"createdAt":"2024-02-20 10:29:02"} ]}

创建新的目标列表


打开windows命令提示符或Mac terminal以运行命令：

curl -L --location-trusted --request POST --url https://api.sse.cisco.com/policies/v2/destinationlists -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -H "Accept: application/json" -d "{\"access\":\"none\",\"isGlobal\":false,\"name\":\"Destination List Name\"}"


输出示例：

{"id":23456789,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708417690,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta":{"destinationCount":0}}

将目标添加到目标列表

• 使用上述提及步骤获取destinationListId，获取所有目标列表

打开windows命令提示符或Mac terminal以运行命令：

curl -L --location-trusted --request POST --url https://api.sse.cisco.com/policies/v2/destinationlists/{destinationListId}/destinations -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -d "[{\"destination":"cisco.com\"},{\"destination\":\"10.10.10.10\"},{\"destination\":\"www.subdomain.cisco.com\/resource\"}]"

输出示例：

{"status":{"code":200,"text":"OK"},"data":{"id":17804929,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708420546,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta": {"destinationCount":3}}}

删除目标列表


• 使用上述提及步骤获取destinationListId，获取所有目标列表

打开windows命令提示符或Mac terminal以运行命令：

curl -L --location-trusted --request DELETE --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId -H "Authorization: Bearer YourAccessToken"​

输出示例：

{"status":{"code":200,"text":"OK"},"data":[]}

从目标列表中删除目标

• 使用上述提及步骤获取destinationListId，获取所有目标列表
• 使用前面提到的步骤id 获取列表中需要删除的特定目标的地址，获取目标列表中的所有目标

打开windows命令提示符或Mac terminal以运行命令：

curl -L --location-trusted --request DELETE --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId/destinations/remove -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -H "Accept: application/json" -d "[id1,id2]"

输出示例：

{"status":{"code":200,"text":"OK"},"data":{"id":17804929,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708525645,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta":{"destinationCount":2}}}





故障排除

安全访问API终端使用HTTP响应代码表示API请求成功或失败。通常，2xx范围内的代码指示成功，4xx范围内的代码指示由所提供信息导致的错误，而5xx范围内的代码指示服务器错误。解决问题的方法取决于收到的响应代码：

REST API -响应代码1

REST API -响应代码2此外，在对API相关错误或问题进行故障排除时，需要注意以下速率限制：

• 安全访问API限制

相关信息

• 思科安全访问用户指南
• Cisco技术支持和下载
• 添加安全访问API密钥
• 开发人员用户指南