Cato API简介
Cato API是Cato SASE平台上用于数据和管理功能交互的主要自动化接口。 它使用GraphQL进行灵活查询和高效的数据检索，支持以下两种操作：
只读操作（数据提取）
变更操作（配置更改）
有关详细的架构参考，请参阅Cato API文档：https://api.catonetworks.com/documentation/
API端点格式为：https://api.catonetworks.com/api/v1/graphql2
API 生命周期
有关API生命周期和使用指南的完整概述，请参阅 Cato API简介
如何使用Cato API密钥
为了认证请求到Cato API，在您的API客户端中包括名为x-api-key的HTTP头。 使用格式： x-api-key: <api-key>，将此头的值设置为您的Cato API密钥。 例如： x-api-key: abcdef12345。 这个头验证您的请求并根据与您密钥相关的权限授予对相关Cato API端点的访问。
在Cato批准集成范围文件之后，将提供API密钥和沙盒环境。
架构变更
Cato的潜在破坏性变更的SLA记录在宣布和管理潜在破坏性变更部分的什么是Cato API文章中。
即将到达生命周期结束(EoL)的API和字段会在API文档中标记为已废弃。同时提供推荐替代品和计划的EoL日期。
此外，潜在的破坏性变更会在Cato API潜在的破坏性变更和EoL文章中进行传达。 强烈建议技术合作伙伴关注本文以收到即将进行的架构更新和废弃的通知。
速率限制和合理使用
速率限制策略定义了每个账户允许的最大请求吞吐量，旨在确保平台的稳定性和资源的合理使用。 集成应实现适当的重试和回退机制来处理速率限制响应。 详细信息请参阅了解Cato API速率限制文章。
核心API集成端点
以下是早期集成和数据摄取过程中使用的最常见的API：
数据类型 | API | 目的 | 典型用例 |
原始事件/安全遥测 | 推荐用于原始事件日志和安全遥测数据的入口点。 | SIEM摄取、安全监控、合规日志记录、威胁检测。 | |
管理审计日志 | 检索管理员操作及配置更改的审计日志。 | 合规审计、变更跟踪、治理监控。 | |
应用程序&流分析 | 提供应用程序使用统计和流量性能指标随时间的变化。 | 应用程序监控、网络性能分析、使用报告。 | |
安全事件/警报 | 关于安全事件和关联警报的高级见解。 | SOC工作流、事件管理、警报增强。 | |
流量指标 | 跨站点和远程用户的流量和使用指标。 | 网络使用分析、容量规划和报告仪表板。 | |
连接性&库存快照 | 站点、套接字和用户的连接状态和库存信息。 | 基础设施监控、拓扑可见性、环境发现。 | |
设备库存&属性 | 提供平台发现的设备库存及相关属性。 | 资产管理系统、物联网/运营技术可见性、设备分类和库存跟踪。 | |
套接字端口指标 | 提供套接字接口和端口的当前和历史指标。 | 基础设施监控、链路健康监控、容量规划和网络故障排除。 |
有关完整的API操作定义和示例响应，请参阅Cato GraphQL API参考文档。
参考工具和示例
为了支持开发和集成工作流，Cato提供了多个参考资源：
Cato GitHub账户 - 示例代码、API助手工具、Jupyter笔记本、Postman集合和CLI实用程序。 示例：
数据分析 - Jupyter笔记本演示事件源的使用案例。
Cato工具箱 - 通用助手，用于API消费和测试，包括Python代码以提取事件。
GraphQL Playground - 基于浏览器的交互工具，用于测试API查询。 有关详细信息，请参阅从GraphQL Playground连接到Cato API。
Cato Remote MCP Server - 通过模型上下文协议（MCP）启用与Cato API的集成，使用AI助手和LLM工具。 这允许使用自然语言或AI驱动的工作流与Cato数据进行交互。 有关更多信息，请参阅：使用Cato Remote MCP 服务器。
支持和社区资源
合作伙伴可以提出与API相关的问题。