Introducción a Cato API
La API de Cato es la interfaz de automatización principal para interactuar con datos y funciones de gestión en la plataforma Cato SASE. Usa GraphQL para consultas flexibles y recuperación eficiente de datos, permitiendo ambos:
Operaciones de solo lectura (extracción de datos)
Operaciones de mutación (cambios de configuración)
Para referencia de esquemas detallada, consulte la documentación de API de Cato: https://api.catonetworks.com/documentation/
El punto final de la API está en el formato: https://api.catonetworks.com/api/v1/graphql2
Ciclo de Vida de la API
Para una visión completa del ciclo de vida de la API y las pautas de uso, consulte Qué es la API de Cato
Cómo Usar Claves de API de Cato
Para autenticar solicitudes a la API de Cato, incluye un encabezado HTTP llamado x-api-key en tu cliente API. Establece el valor de este encabezado en tu clave de API de Cato usando el formato: x-api-key: <api-key>. Por ejemplo: x-api-key: abcdef12345. Este encabezado autoriza tu solicitud y otorga acceso a los endpoints de la API de Cato relevantes según los permisos asociados con tu clave.
Se proporcionarán claves API y un entorno de prueba después de la aprobación de Cato del documento de alcance de integración.
Cambios en el esquema
El SLA de Cato para cambios potencialmente críticos está documentado en la sección Anunciando y Gestionando Cambios Potencialmente Críticos del artículo Qué es la API de Cato.
Las APIs y campos planeados para Fin de Vida (EoL) están identificados como obsoletos en la documentación de la API. Cuando estén disponibles, se provee un reemplazo recomendado y la fecha programada de EoL.
Además, los cambios potencialmente críticos se comunican en el artículo Cambios Potencialmente Críticos de la API de Cato y EoL. Se recomienda encarecidamente a los Socios Tecnológicos seguir este artículo para recibir notificaciones con respecto a próximas actualizaciones de esquema y obsolescencias.
Limitación de Tasa y Uso Justo
La política de limitación de tasa define el rendimiento máximo de solicitudes permitido por cuenta y está diseñada para asegurar la estabilidad de la plataforma y el uso justo de recursos. Las integraciones deben implementar mecanismos adecuados de reintentos y retrocesos para manejar respuestas de límite de tasa. Para más detalles, consulte el artículo Comprendiendo la Limitación de Tasa del API de Cato.
Puntos Finales del API Principal para Integración
A continuación se presentan las APIs más comunes utilizadas durante la integración temprana y la ingestión de datos:
Tipo de Datos | API | Propósito | Casos de Uso Típicos |
Eventos en Bruto / Telemetría de Seguridad | Punto de entrada recomendado para consumir registros de eventos en bruto y telemetría de seguridad. | Ingestión de SIEM, monitoreo de seguridad, registros de cumplimiento, detección de amenazas. | |
Registros de Auditoría Administrativa | Recupera registros de auditoría para acciones de administración y cambios de configuración. | Auditoría de cumplimiento, seguimiento de cambios, monitoreo de gobernanza. | |
Análisis de Aplicaciones y Flujos | Proporciona estadísticas de uso de aplicaciones y métricas de rendimiento de flujos a lo largo del tiempo. | Monitoreo de aplicaciones, análisis del rendimiento de la red, reporte de uso. | |
Incidentes de Seguridad / Alertas | Información de alto nivel sobre incidentes de seguridad y alertas correlacionadas. | Flujos de trabajo de SOC, gestión de incidentes, enriquecimiento de alertas. | |
Métricas de Tráfico | Métricas de tráfico y uso a través de sitios y usuarios remotos. | Analítica de uso de la red, planificación de capacidad y paneles de informes. | |
Instantánea de Conectividad e Inventario | Estado de conectividad e información de inventario para sitios, sockets y usuarios. | Monitoreo de infraestructura, visibilidad de topología y descubrimiento de entorno. | |
Inventario y Atributos de Dispositivos | Proporciona inventario de dispositivos y atributos asociados descubiertos por la plataforma. | Sistemas de gestión de activos, visibilidad IoT/OT, clasificación de dispositivos y seguimiento de inventario. | |
Métricas de Puerto de Socket | Proporciona métricas actuales e históricas para interfaces y puertos de sockets. | Monitoreo de infraestructura, monitoreo de salud de enlaces, planificación de capacidad y solución de problemas de red. |
Para definiciones completas de operaciones de API y ejemplos de respuestas, consulte la Referencia de API GraphQL de Cato.
Herramientas de Referencia y Ejemplos
Para apoyar los flujos de trabajo de desarrollo e integración, Cato proporciona varios recursos de referencia:
Cuenta de GitHub de Cato - Código de ejemplo, herramientas auxiliares de API, cuadernos de Jupyter, colecciones de Postman y utilidades CLI. Ejemplos:
data-analytics - Cuadernos de Jupyter que demuestran casos de uso de eventsFeed.
cato-toolbox - Herramientas de propósito general para consumo y prueba de API, incluido el código de Python para obtener eventos.
Playground de GraphQL - Una herramienta interactiva basada en navegador para probar consultas de API. Consulte API de Cato desde el Playground de GraphQL para más detalles.
Servidor MCP Remoto de Cato - Habilita la integración con la API de Cato usando asistentes de IA y herramientas basadas en LLM a través del Protocolo de Contexto de Modelo (MCP). Esto permite interactuar con datos de Cato usando lenguaje natural o flujos de trabajo impulsados por IA. Para más información, consulte: Trabajando con el Servidor MCP Remoto de Cato.
Recursos de Soporte y Comunidad
Los socios pueden plantear preguntas relacionadas con la API a través de