Introduction à l'API Cato
L'API Cato est l'interface d'automatisation principale pour interagir avec les données et les fonctions de gestion sur la plateforme Cato SASE. Elle utilise GraphQL pour des requêtes flexibles et un accès efficace aux données, permettant les deux :
Opérations en lecture seule (extraction de données)
Opérations de mutation (modifications de configuration)
Pour une référence détaillée des schémas, consultez la documentation Cato API : https://api.catonetworks.com/documentation/
Le point de terminaison de l'API est au format : https://api.catonetworks.com/api/v1/graphql2
Cycle de vie de l'API
Pour un aperçu complet du cycle de vie et des directives d'utilisation de l'API, voir Qu'est-ce que l'API Cato
Comment Utiliser les Clés API Cato
Pour authentifier les requêtes à l'API Cato, incluez un en-tête HTTP nommé x-api-key dans votre client API. Définissez la valeur de cet en-tête sur votre clé API Cato en utilisant le format : x-api-key: <api-key>. Par exemple : x-api-key: abcdef12345. Cet en-tête autorise votre requête et accorde l'accès aux points de terminaison API Cato pertinents en fonction des permissions associées à votre clé.
Les clés API et un environnement de simulation seront fournis après l'approbation par Cato du document de cadrage de l'intégration.
Modifications du Schéma
Le SLA de Cato pour les modifications potentiellement ruptures est documenté dans la section Annonce et Gestion des Modifications Potentiellement Casse de l'article Qu'est-ce que l'API Cato.
Les APIs et les champs prévus pour la fin de vie (EoL) sont identifiés comme dépréciés dans la documentation API. Lorsqu'ils sont disponibles, un remplacement recommandé et la date prévue d'EoL sont fournis.
De plus, les changements potentiellement perturbateurs sont communiqués dans l'article Cato API Modifications Potentiellement Perturbatrices et EoL. Les partenaires technologiques sont fortement encouragés à suivre cet article pour recevoir des notifications concernant les mises à jour du schéma à venir et les dépréciations.
Limitation du Débit et Utilisation Juste
La politique de limitation du débit définit le débit maximum de requêtes autorisé par compte et est conçue pour assurer la stabilité de la plateforme et une utilisation équitable des ressources. Les intégrations doivent mettre en œuvre des mécanismes appropriés de reprise et de retours en arrière pour gérer les réponses de limitation de débit. Pour plus de détails, reportez-vous à l'article Comprendre la Limitation de Débit de l'API Cato.
Points d'Extrémité API de Base pour l'Intégration
Ci-dessous sont indiquées les API les plus courantes utilisées durant l'intégration précoce et l'ingestion des données :
Type de Donnée | API | Objectif | Cas d'Utilisation Typiques |
Événements Bruts / Télémétrie de Sécurité | Point d'entrée recommandé pour consommer les journaux d'événements bruts et la télémétrie de sécurité. | Ingestion SIEM, surveillance de la sécurité, journalisation de conformité, détection de menaces. | |
Journaux d'Audit Administratif | Récupère les journaux d'audit pour les actions administratives et les modifications de configuration. | Audit de conformité, suivi des modifications, surveillance de la gouvernance. | |
Analyses d'Applications & de Flux | Fournit des statistiques d'utilisation des applications et des mesures de performances des flux au fil du temps. | Surveillance des applications, analyse des performances réseau, rapports d'utilisation. | |
Incidents de Sécurité / Alertes | Aperçus de haut niveau sur les incidents de sécurité et les alertes corrélées. | Flux de travail SOC, gestion des incidents, enrichissement des alertes. | |
Métriques de Trafic | Métriques de trafic et d'utilisation à travers les sites et les utilisateurs distants. | Analyses de l'utilisation du réseau, planification de capacité, et tableaux de bord de reporting. | |
Instantané de Connectivité & d'Inventaire | Statut de la connectivité et informations d'inventaire pour les sites, sockets et utilisateurs. | Surveillance d'infrastructure, visibilité de la topologie, et découverte d'environnement. | |
Inventaire des Appareils & Attributs | Fournit l'inventaire des appareils et les attributs associés découverts par la plateforme. | Systèmes de gestion des actifs, visibilité IoT/OT, classification des appareils, et suivi d'inventaire. | |
Métriques de Port de Socket | Fournit des métriques actuelles et historiques pour les interfaces de socket et les ports. | Surveillance de l'infrastructure, surveillance de la santé des liens, planification de capacité, et dépannage réseau. |
Pour les définitions complètes des opérations API et des exemples de réponses, voir la Référence API GraphQL de Cato.
Outils de Référence et Exemples
Pour soutenir les développements et les flux de travail d'intégration, Cato fournit plusieurs ressources de référence :
Compte GitHub Cato - Code d'exemple, outils d'assistance API, notebooks Jupyter, collections Postman, et utilitaires CLI. Exemples :
data-analytics - Notebooks Jupyter présentant des cas d'utilisation eventsFeed.
cato-toolbox - Assistants à usage général pour la consommation et le test de l'API, y compris du code Python pour extraire les événements.
GraphQL Playground - Outil interactif basé sur le navigateur pour tester les requêtes API. Voir API Cato depuis le GraphQL Playground pour plus de détails.
Serveur MCP Remote Cato - Permet l'intégration avec l'API Cato en utilisant des assistants AI et des outils basés sur LLM via le Protocole de Contexte Modèle (MCP). Cela permet d'interagir avec les données Cato en utilisant le langage naturel ou des workflows pilotés par AI. Pour plus d'informations, voir : Travailler avec le Serveur MCP Remote Cato.
Ressources de Support et Communautaires
Les partenaires peuvent poser des questions liées à l'API à travers