关于 管理中心 REST API
REST API 是一种基于“RESTful”准则的应用程序编程接口 (API),您可以在运行 6.1 或更高版本的任何 管理中心快速启用该接口,并配合 REST 客户端一起使用。
安装 REST 客户端之后,您可以联系特定 管理中心的 REST 代理以及使用标准 HTTP 方法访问当前的配置信息,并可以发布其他配置参数。
此产品的文档集力求使用非歧视性语言。在本文档集中,非歧视性语言是指不隐含针对年龄、残障、性别、种族身份、族群身份、性取向、社会经济地位和交叉性的歧视的语言。由于产品软件的用户界面中使用的硬编码语言、基于 RFP 文档使用的语言或引用的第三方产品使用的语言,文档中可能无法确保完全使用非歧视性语言。 深入了解思科如何使用包容性语言。
思科可能会在某些地方提供本内容的当地语言翻译版本。请注意,翻译版本仅供参考,如有任何不一致之处,以本内容的英文版本为准。
管理中心 REST API 提供轻量级 API 来管理 管理中心。
REST API 是一种基于“RESTful”准则的应用程序编程接口 (API),您可以在运行 6.1 或更高版本的任何 管理中心快速启用该接口,并配合 REST 客户端一起使用。
安装 REST 客户端之后,您可以联系特定 管理中心的 REST 代理以及使用标准 HTTP 方法访问当前的配置信息,并可以发布其他配置参数。
在这些新增功能表中,URL 中添加了空格以提高可读性。使用 URL 时,请删除空格。
名称 |
方法 |
URL |
---|---|---|
机箱 |
||
Switchmode |
POST |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis /operational/switchmode |
部署 |
||
待处理的更改请求 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /deployment /pendingchangesrequests |
设备 |
||
虚拟访问接口 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /operational/virtualaccessinterfaces |
策略 |
||
访问列表设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies /{containerUUID}/accesslistsettings /{object_UUID} |
VPN 隧道状态 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /policy/vpntunnelstatuses |
状态 |
||
下载报告 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /job/taskstatuses/{objectId} /operational/downloadreports |
系统配置 |
||
更改管理配置 |
GET、PUT |
/api/fmc_platform/v1/systemconfiguration /changemanagementconfigs |
名称 |
方法 |
URL |
---|---|---|
分析(新) |
||
活动会话 |
GET、DELETE |
|
注销 |
POST |
|
用户活动 |
GET、DELETE |
|
审计 |
||
配置更改 |
GET |
|
机箱 |
||
应用信息 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID}/appinfo |
机箱接口事件 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID} /chassisinterfaceevents |
Etherchannel 接口 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID} /etherchannelinterfaces |
故障摘要 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID} /faultsummary |
实例摘要 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID} /instancesummary |
接口 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID} /interfaces |
接口摘要 |
GET |
|
资产摘要 |
GET |
|
逻辑设备 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID}/logicaldevices |
SNMP 设置 |
GET、PUT |
|
子接口 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/{ |
设备 |
||
DDNS 设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/dhcp/ddnssettings |
DHCP 中继设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/dhcp/dhcprelaysettings |
DHCP 服务器 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/dhcp/dhcpserver |
管理融合模式 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/managementconvergencemode |
模型迁移 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /devices/operational/modelmigrations |
虚拟双向转发策略 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/virtualrouters/{virtualrouterUUID}/bfdpolicies |
运行状况 |
||
隧道详细信息 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /health/tunnelstatuses/{containerUUID}/tunneldetails |
集成 |
||
CD FMC 快照 |
GET、POST |
/api/fmc_config/v1/domain/{domainUUID} /integration/cdfmcsnapshot/{objectId} |
刷新 SecureX 配置 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /integration/operational/refreshsecurexconfigs |
对象 |
||
Azure AD 领域 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/azureadrealms |
Azure AD 状态 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /object/azureadstatuses |
密码套件列表 |
GET、POST |
/api/fmc_config/v1/domain/{domainUUID} /object/ciphersuitelists |
自定义 SI IP 列表下载 |
GET |
|
自定义 SI IP 列表 |
GET、PUT、POST、DELETE |
|
自定义 SI URL 列表下载 |
GET |
|
自定义 SI URL 列表 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/customsiurllists |
可分辨名称组 |
GET | /api/fmc_config/v1/domain/{domainUUID} /object/distinguishednamegroups |
可分辨名称 |
GET、POST |
/api/fmc_config/v1/domain/{domainUUID} /object/distinguishednames |
下载 Azure AD 领域 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /object/azureadrealms/{realmId}/download |
外部 CA 证书组 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /object/externalcacertificategroups |
外部 CA 证书 |
GET、POST |
/api/fmc_config/v1/domain/{domainUUID} /object/externalcacertificates |
外部证书组 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /object/externalcertificategroups |
外部证书 |
GET、POST |
/api/fmc_config/v1/domain/{domainUUID} /object/externalcertificates |
文件类别 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /object/filecategories |
文件类型 |
GET |
|
内部证书组 |
GET |
|
NTP 服务器 |
GET、PUT、POST、DELETE |
|
重叠 |
POST |
|
资源配置文件 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/resourceprofiles |
安全客户端自定义 |
GET、PUT、POST、DELETE |
|
SI 网络源 |
PUT、POST、DELETE |
|
SI URL 源 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/siurlfeeds |
测试 Azure AD 领域 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /object/testazureadrealms |
用户和组 |
GET |
|
VLAN 组标签 |
DELETE |
|
策略 |
||
应用组 |
GET、PUT、POST、DELETE |
|
应用 |
GET、PUT、POST、DELETE |
|
机箱平台设置策略 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies |
解密策略 |
GET、PUT、POST、DELETE |
|
解密策略规则 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /policy/decryptionpolicies/{containerUUID} /decryptionpolicyrules/{ |
DNS 设置 |
GET、POST |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings |
文件策略 |
PUT、POST、DELETE |
|
文件规则 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /policy/filepolicies/{containerUUID}/filerules |
FTD 平台设置策略 |
PUT、POST、DELETE |
|
HTTP 访问设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /httpaccesssettings/{ |
NAT 豁免规则 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /policy/natexemptrules/{deviceId} |
NetFlow 策略 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /netflowpolicies/{ |
安全客户端自定义设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/ravpns/{containerUUID} /secureclientcustomizationsettings |
SSH 客户端设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /sshclientsettings |
SSH 服务器设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /sshserversettings |
SNMP 设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings |
系统日志设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{ |
时间同步设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /timesynchronizationsettings |
时区设置 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /timezonesettings |
ZTNA 策略 |
GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies |
系统配置 |
||
远程管理访问 |
GET、PUT |
api/fmc_platform/v1/systemconfiguration /remotemanagementaccess |
故障排除 |
||
设备 |
POST |
/api/fmc_troubleshoot/v1/domain/{domainUUID} /troubleshoot/device |
用户 |
||
用户 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /users/users |
名称 |
方法 |
URL |
---|---|---|
备份(新) |
||
设备备份 |
POST |
|
下载备份 |
GET、按 ID GET |
|
备份文件 |
GET、按 ID GET、DELETE |
|
机箱 |
||
机箱物理接口 |
GET、按 ID GET、PUT |
|
设备 |
||
双向转发策略 |
GET、按 ID GET、PUT、POST、DELETE |
|
环回接口 |
GET、按 ID GET、PUT、POST、DELETE |
|
设备集群 |
||
集群运行状况监控设置 |
按 ID GET、PUT |
|
运行状况 |
||
远程访问 VPN 网关 |
GET、按 ID GET |
|
终止 VPN 会话 |
POST |
|
Cisco Secure Dynamic Attributes Connector |
GET、POST |
|
路径监控的接口 |
GET |
|
集成 |
||
隧道部署 |
GET、POST |
|
隧道文字记录 |
按 ID GET |
|
数据中心 |
GET |
|
Umbrella 文字记录 |
按 ID GET |
|
对象 |
||
双向转发模板 |
GET、按 ID GET、PUT、POST、DELETE |
|
DHCP IPv6 池 |
GET、按 ID GET、PUT、POST、DELETE |
|
下载内部 CA |
POST |
|
内部证书授权 |
GET、按 ID GET、PUT、POST、DELETE |
|
内部证书 |
GET、按 ID GET、PUT、POST、DELETE |
|
安全组标记 |
PUT、POST、DELETE |
|
SI URL 列表 |
PUT、POST、DELETE |
|
验证证书文件 |
POST |
|
策略 |
||
FlexConfig 策略 |
GET、按 ID GET、POST |
|
FTD 平台设置 |
GET、按 ID GET |
|
负载均衡设置 |
GET、按 ID GET、PUT |
|
FlexConfig 迁移 |
POST |
|
名称 |
方法 |
URL |
---|---|---|
机箱 |
||
评估操作 |
GET |
|
分支接口 |
POST |
|
加入接口 |
POST |
|
部署 |
||
下载报告 |
GET |
|
电子邮件报告 |
GET |
|
设备 |
||
EIGRP 路由 |
GET、按 ID GET、PUT、POST、DELETE |
|
虚拟 EIGRP 路由 |
GET、按 ID GET、PUT、POST、DELETE |
|
设备设置 |
GET、PUT |
|
变更管理 |
POST |
|
集成 |
||
EBS 快照 |
按 ID GET、POST |
|
测试 Umbrella 连接 |
POST |
|
Umbrella 连接 |
GET、按 ID GET、PUT、POST |
|
状态 |
||
任务状态 |
GET |
|
对象 |
||
AnyConnect 外部浏览器软件包 |
PUT、POST、DELETE |
|
AnyConnect 软件包 |
PUT、POST、DELETE |
|
AnyConnect 配置文件 |
PUT、POST、DELETE |
|
认证登记 |
PUT、POST、DELETE |
|
证书映射 |
PUT、POST、DELETE |
|
组策略 |
PUT、POST、DELETE |
|
主机扫描包 |
PUT、POST、DELETE |
|
IPv4 地址池 |
PUT、POST、DELETE |
|
IPv6 地址池 |
PUT、POST、DELETE |
|
Umbrella 保护策略 |
GET、POST |
|
RADIUS 服务器组 |
PUT、POST、DELETE |
|
SSO 服务器 |
PUT、POST、DELETE |
|
策略 |
||
自动 NAT 规则 |
PUT、DELETE |
|
手动 NAT 规则 |
PUT、DELETE |
|
NAT 规则 |
DELETE |
|
运行状况策略 |
GET、按 ID GET |
|
策略锁定 |
GET、POST |
|
RA VPN |
PUT、POST、DELETE |
|
地址分配设置 |
PUT |
|
证书映射设置 |
PUT |
|
连接配置文件 |
PUT、POST、DELETE |
|
IPSec 高级设置 |
GET、按 ID GET、PUT |
|
IPSec 加密映射 |
GET、按 ID GET、PUT |
|
LDAP 属性映射 |
GET、按 ID GET、PUT |
|
S2S VPN 摘要 |
GET |
|
Umbrella DNS 策略 |
GET、按 ID GET、PUT、POST、DELETE |
|
Umbrella DNS 规则 |
GET、按 ID GET、PUT |
|
搜索 |
||
设备 |
GET |
|
许可 |
||
设备许可证 |
GET、按 ID GET、PUT、按 ID PUT |
|
智能许可证 |
GET、POST |
|
更新 |
||
升级快照 |
POST |
|
故障排除 |
||
任务 |
POST |
|
新特性和功能包括:
添加了错误 401 无效会话和 429 写入次数过多。
从字段名称和说明中删除了带有偏见的术语。
在 API Explorer 中添加了“故障排除”、“网络映射”和“机箱”部分。
名称 |
方法 |
URL |
---|---|---|
故障排除 |
||
数据包跟踪器文件 |
DELETE、按 ID DELETE |
|
网络映射 |
||
Netmap 主机 |
GET、按 ID GET、POST、DELETE |
|
漏洞 ((VDB) Host Vulns) |
GET、按 ID GET、POST、DELETE |
/api/fmc_netmap/v1/domain/{domainUUID}/vulns/ |
用户 |
||
Duo 配置 |
GET、按 ID GET、PUT |
|
部署服务 |
||
作业历史记录 |
GET、按 ID GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /deployment/jobhistories |
下载报告 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /deployment/jobhistories/{containerUUID}/operational/downloadreports |
电子邮件报告 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /deployment/jobhistories/{containerUUID}/operational/emailreports |
设备集群 |
||
威胁防御 集群就绪性检查 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /deviceclusters/ftdclusterreadinesscheck |
威胁防御 集群设备命令 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /deviceclusters/{containerUUID}/operational/ftdclusterdevicecommands |
运行状况服务 |
||
隧道状态 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /health/tunnelstatuses |
隧道摘要 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /health/tunnelsummaries |
机箱 |
||
管理中心 托管机箱 |
GET、按 ID GET |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis |
网络模块 |
GET、按 ID GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID}/networkmodules |
同步网络模块 |
PUT |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID}/operational/syncnetworkmodule |
机箱接口 |
GET、按 ID GET |
/api/fmc_config/v1/domain/{domainUUID} /chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces |
设备服务 |
||
ECMP 区域 |
GET、按 ID GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/routing/ecmpzones |
虚拟 ECMP 区域 |
GET、按 ID GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/virtualrouters/{virtualrouterUUID}
/ecmpzones |
Packet Tracer |
POST |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /operational/packettracer |
数据包跟踪器 PCAP |
POST |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /operational/packettracerpcap |
基于策略的路由 |
GET、按 ID GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/policybasedroutes |
基于虚拟策略的路由 |
GET、按 ID GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/virtualrouters/{virtualrouterUUID}/policybasedroutes |
VTEP 策略 |
GET、按 ID GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /vteppolicies |
VNI 接口 |
GET、按 ID GET、PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /vniinterfaces |
威胁防御 所有接口 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /ftdallinterfaces |
集成 |
||
动态属性源 |
GET、PUT |
/api/fmc_config/v1/domain/{domainUUID} /integration/dynamicattributesfeeds |
对象 |
||
AnyConnect 外部浏览器软件包 |
GET、按 ID GET |
/api/fmc_config/v1/domain/{domainUUID} /object/anyconnectexternalbrowserpackages |
批量动态对象 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /object/bulkdynamicobjects |
扩展社区列表 |
GET、按 ID GET、GET 覆盖、按 ID GET 覆盖、OUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/extendedcommunitylists |
数据包跟踪器 PCAP 列表 |
GET |
/api/fmc_config/v1/domain/{domainUUID} /object/packettracerpcaplist |
数据包跟踪器 PCAP 上传 |
POST |
/api/fmc_config/v1/domain/{domainUUID} /object/packettracerpcapupload |
更新 |
||
恢复升级 |
POST |
/api/fmc_platform/v1/updates/revertupgrades |
名称 |
方法 |
URL |
---|---|---|
设备集群 |
||
威胁防御 设备集群(现有) |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /deviceclusters/ftddevicecluster/{objectId} |
设备服务 |
||
BGP |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/routing/bgp |
BGP 常规设置 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/bgpgeneralsettings |
对象 |
||
AS 路径列表(现有) |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/aspathlists |
扩展社区列表 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/expandedcommunitylists |
扩展访问列表 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domain_UUID} /object/extendedaccesslists |
IPV4 前缀列表(现有) |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/ipv4prefixlists |
IPV6 前缀列表 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/ipv6prefixlists |
策略列表 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/policylists |
路由映射 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/routemaps |
标准访问列表 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/standardaccesslists |
标准社区列表 |
PUT、POST、DELETE |
/api/fmc_config/v1/domain/{domainUUID} /object/standardcommunitylists |
默认情况下,启用 管理中心 REST API。
![]() 注 |
在 UCAPL 模式下,禁用 REST API。 |
步骤 1 |
选择系统( |
步骤 2 |
选中启用 REST API (Enable REST API)。 |
步骤 3 |
点击保存 (Save)。 |
思科建议使用以下最佳做法实现最佳的 REST API 效果:
尽可能将 UI 用户和 API 用户分开。除非特别需要,否则不要将管理员帐户用作 API 用户。
不要为 API 用户提供超出所需的特权。
务必要验证来自服务器的内容。
验证/净化 JSON 内容,因为其中可能包括嵌入的可执行代码。
如果使用的是 CC 或 UCAPL 模式,则应禁用对 管理中心和托管设备的 REST API 访问。
管理中心 REST API 的其他资源可在 https://developer.cisco.com/secure-firewall/management-center/ 的思科 DevNet 上找到。