Введение в API Cato
Cato API - основной интерфейс автоматизации для взаимодействия с данными и функциями управления на платформе Cato SASE. Она использует GraphQL для гибкого запроса и эффективного извлечения данных, позволяя обоим:
Операции только для чтения (извлечение данных)
Операции мутации (изменения конфигурации)
Для подробного справочника по схеме смотрите документацию по API Cato: https://api.catonetworks.com/documentation/
Конечная точка API представлена в формате: https://api.catonetworks.com/api/v1/graphql2
Жизненный цикл API
Для полного обзора жизненного цикла API и руководящих принципов использования см. Что такое API Cato
Как использовать API-ключи Cato
Чтобы аутентифицировать запросы к Cato API, включите HTTP заголовок с именем x-api-key в вашем клиенте API. Установите значение этого заголовка как ваш Cato API-ключ, используя формат: x-api-key: <api-key>. Например: x-api-key: abcdef12345. Этот заголовок авторизует ваш запрос и предоставляет доступ к соответствующим конечным точкам Cato API на основе разрешений, связанных с вашим ключом.
API-ключи и тестовая среда будут предоставлены после одобрения интеграционного документа компанией Cato.
Изменения схемы
SLA компании Cato для потенциально значительных изменений документировано в разделе Объявление и управление потенциально значительными изменениями статьи Что такое API Cato.
API и поля, запланированные для прекращения поддержки (EoL), обозначены как устаревшие в документации API. Где доступно, предоставлен рекомендованный замена и предполагаемая дата прекращения поддержки.
Кроме того, потенциально значительные изменения сообщаются в статье Потенциально значительные изменения и EoL API Cato. Технологическим партнерам настоятельно рекомендуется следовать этой статье, чтобы получать уведомления о предстоящих обновлениях схемы и устаревании.
Ограничения скорости и честное использование
Политика ограничения скорости определяет максимальный пропускной диапазон запросов, разрешенный на учетную запись, и предназначена для обеспечения стабильности платформы и справедливого использования ресурсов. Интеграции должны реализовывать соответствующие механизмы повторного обращения и отложенного выполнения для обработки ответов об ограничении скорости. Для получения подробной информации обратитесь к статье Понимание ограничений скорости API Cato.
Ключевые конечные точки API для интеграции
Ниже перечислены самые распространенные API, используемые в процессе ранней интеграции и поступления данных:
Тип данных | API | Назначение | Типичные случаи использования |
Сырье / Теле метрики безопасности | Рекомендуемая начальная точка для потребления сырых журналов событий и телеметрии безопасности. | Поглощение SIEM, мониторинг безопасности, ведение журналов соответствия, обнаружение угроз. | |
Журналы аудита администрирования | Извлекает журналы аудита для действий администратора и изменений конфигурации. | Аудит соответствия, отслеживание изменений, мониторинг управления. | |
Аналитика приложения и потока | Предоставляет статистику использования приложений и показатели производительности потока с течением времени. | Мониторинг приложений, анализ производительности сети, отчет об использовании. | |
Инциденты безопасности / Оповещения | Высокоуровневые выводы по инцидентам безопасности и коррелированным оповещениям. | Рабочие процессы SOC, управление инцидентами, обогащение оповещений. | |
Метрики трафика | Метрики трафика и использования на площадках и удаленных пользователях. | Аналитика использования сети, планирование емкости и панели мониторинга. | |
Снимок соединяемости и инвентаризации | Статус подключения и инвентарная информация по площадкам, сокетам и пользователям. | Мониторинг инфраструктуры, видимость топологии и обнаружение среды. | |
Инвентаризация устройств и атрибуты | Предоставляет инвентаризацию устройств и связанные атрибуты, обнаруженные платформой. | Системы управления активами, видимость IoT/OT, классификация устройств, и отслеживание инвентаря. | |
Метрики портов сокетов | Предоставляет текущие и исторические метрики для интерфейсов и портов сокетов. | Мониторинг инфраструктуры, мониторинг состояния соединений, планирование емкости и устранение неполадок сети. |
Для определения полных операций API и примеров ответов обратитесь к Справочник по API Cato GraphQL.
Справочные инструменты и примеры
Чтобы поддержать развитие и рабочие процессы интеграции, Cato предоставляет несколько справочных ресурсов:
Cato GitHub Account - Примеры кода, инструменты помощи для API, Jupyter ноутбуки, коллекции Postman и утилиты CLI. Примеры:
data-analytics - Jupyter ноутбуки, демонстрирующие случаи использования eventsFeed.
cato-toolbox - Универсальные помощники для использования и тестирования API, включая Python-код для извлечения событий.
GraphQL Playground - Интерактивный инструмент в браузере для тестирования запросов API. См. API Cato из GraphQL Playground для получения подробной информации.
Cato Remote MCP Server - Включает интеграцию с API Cato с использованием AI-ассистентов и инструментов на базе LLM через Протокол Контекста Модели (MCP). Это позволяет взаимодействовать с данными Cato, используя естественный язык или AI-руководимые рабочие процессы. Для получения дополнительной информации см. Работа с удаленным сервером MCP Cato.
Ресурсы поддержки и сообщества
Партнеры могут задавать вопросы, связанные с API, через