Introdução à API Cato
A API Cato é a principal interface de automação para interagir com os dados e funções de gerenciamento na plataforma Cato SASE. Ele usa GraphQL para consultas flexíveis e recuperação eficiente de dados, permitindo ambos:
Operações somente leitura (extração de dados)
Operações de mutação (mudanças de configuração)
Para referência detalhada do esquema, consulte a documentação da API Cato: https://api.catonetworks.com/documentation/
O endpoint da API está no formato: https://api.catonetworks.com/api/v1/graphql2
Ciclo de vida da API
Para uma visão completa do ciclo de vida da API e diretrizes de uso, veja O que é a API Cato
Como Utilizar Chaves da API Cato
Para autenticar solicitações na API Cato, inclua um cabeçalho HTTP chamado x-api-key no seu cliente de API. Defina o valor deste cabeçalho para sua chave de API Cato usando o formato: x-api-key: <api-key>. Por exemplo: x-api-key: abcdef12345. Este cabeçalho autoriza sua solicitação e concede acesso aos endpoints relevantes da API Cato com base nas permissões associadas à sua chave.
Chaves de API e um ambiente sandbox serão fornecidos após a aprovação da Cato do documento de escopo de integração.
Mudanças de Esquema
O SLA da Cato para mudanças potencialmente disruptivas está documentado na seção Anunciando e Gerenciando Mudanças Potencialmente Disruptivas do artigo O que é a API Cato.
APIs e campos planejados para Fim de Vida (EoL) são identificados como obsoletos na documentação API. Onde disponível, um substituto recomendado e a data programada de EoL são fornecidos.
Além disso, mudanças potencialmente disruptivas são comunicadas no artigo Mudanças Potencialmente Disruptivas e EoL da API Cato. Parceiros de Tecnologia são fortemente incentivados a seguir este artigo para receber notificações sobre atualizações de esquema e depreciações futuras.
Limitação de Taxa e Uso Justo
A política de limitação de taxa define a máxima taxa de requisições permitida por conta e é projetada para garantir a estabilidade da plataforma e o uso justo dos recursos. As integrações devem implementar mecanismos adequados de repetição e retrocesso para lidar com respostas de limitação de taxa. Para detalhes, consulte o artigo Entendendo a Limitação de Taxa da API Cato.
Pontos Finais Principais da API para Integração
Abaixo estão as APIs mais comuns usadas durante a integração inicial e ingestão de dados:
Tipo de Dados | API | Propósito | Casos de Uso Típicos |
Eventos Brutos / Telemetria de Segurança | Ponto de entrada recomendado para consumir logs de eventos brutos e telemetria de segurança. | Ingestão de SIEM, monitoramento de segurança, logging de conformidade, detecção de ameaças. | |
Logs de Auditoria Administrativos | Recupera logs de auditoria para ações administrativas e mudanças de configuração. | Auditoria de conformidade, rastreamento de mudanças, monitoramento de governança. | |
Análise de Aplicação & Fluxo | Fornece estatísticas de uso de aplicações e métricas de desempenho de fluxo ao longo do tempo. | Monitoramento de aplicações, análise de desempenho da rede, relatórios de uso. | |
Incidentes de Segurança / Alertas | Insights de alto nível sobre incidentes de segurança e alertas correlacionados. | Workflows de SOC, gerenciamento de incidentes, enriquecimento de alertas. | |
Métricas de Tráfego | Métricas de tráfego e uso em sites e usuários remotos. | Análises de uso de rede, planejamento de capacidade e painéis de relatórios. | |
Snapshoot de Conectividade & Inventário | Status de conectividade e informações de inventário para sites, sockets e usuários. | Monitoramento de infraestrutura, visibilidade de topologia e descoberta de ambiente. | |
Inventário de Dispositivo & Atributos | Fornece inventário de dispositivos e atributos associados descobertos pela plataforma. | Sistemas de gerenciamento de ativos, visibilidade de IoT/OT, classificação de dispositivos e rastreamento de inventário. | |
Métricas de Porta do Socket | Fornece métricas atuais e históricas para interfaces e portas de socket. | Monitoramento de infraestrutura, monitoramento de saúde de links, planejamento de capacidade e resolução de problemas de rede. |
Para definições completas de operações da API e respostas de exemplo, consulte a Referência de API GraphQL Cato.
Ferramentas e Exemplos de Referência
Para apoiar o desenvolvimento e fluxos de trabalho de integração, a Cato fornece vários recursos de referência:
Conta GitHub Cato - Código de exemplo, ferramentas auxiliares de API, notebooks Jupyter, coleções de Postman e utilitários CLI. Exemplos:
data-analytics - Notebooks Jupyter demonstrando casos de uso do eventsFeed.
cato-toolbox - Auxiliares de propósito geral para consumo e teste de API, incluindo código Python para buscar eventos.
Playground GraphQL - Uma ferramenta interativa baseada no navegador para testar consultas API. Veja Cato API do GraphQL Playground para detalhes.
Servidor Remoto MCP Cato - Habilita integração com a API Cato usando assistentes de inteligência artificial e ferramentas baseadas em LLM via o Protocolo de Contexto de Modelo (MCP). Isso permite interagir com os dados da Cato usando linguagem natural ou fluxos de trabalho orientados por inteligência artificial. Para mais informações, veja: Trabalhando com o Servidor Remoto MCP Cato.
Recursos de Suporte e Comunidade
Os Parceiros podem levantar questões relacionadas à API através