技術パートナー向けCato APIリファレンス

Prev Next

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エンドポイントへのアクセスをキーに関連付けられた権限に基づいて付与します。

APIキーとサンドボックス環境は、Catoが統合スコープドキュメントを承認した後に提供されます。

スキーマの変更

CatoのSLAでの潜在的に破壊的な変更に関する情報は、破壊的な変更の発表と管理セクションに記載されています。

EoL(End-of-Life)と計画されたフィールドは、非推奨としてAPIドキュメンテーションで識別されています。推奨される代替オプションと予定されているEoL日が提供されています。

加えて、潜在的に破壊的な変更は、Cato API潜在的に破壊的な変更とEoLの記事で通知されます。 技術パートナーには、この記事をフォローし、今後のスキーマ更新や非推奨情報を受け取りくよう強くお勧めします。

レートリミティングと公正利用

レートリミティングポリシーは、アカウントごとに許可される最大リクエストスループットを定義し、プラットフォームの安定性と公正なリソース使用を保証するように設計されています。 統合には、レート制限応答を処理するための適切な再試行とバックオフ機構を実装する必要があります。 詳細については、Cato APIレートリミティングの理解をご覧ください。

統合のためのコアAPIエンドポイント

以下は、初期の統合やデータ取り込み中に使用される最も一般的なAPIです:

データタイプ

API

目的

典型的なユースケース

生のイベント/セキュリティテレメトリ

eventsFeed

生のイベントログとセキュリティテレメトリを消費するための推奨エントリポイントです。

SIEM取り込み、セキュリティ監視、コンプライアンスログ、脅威検出。

管理監査ログ

auditFeed

管理者のアクションと設定変更の監査ログを取得します。

コンプライアンス監査、変更トラッキング、ガバナンス監視。

アプリケーション&フロー分析

appStats

appStatsTimeSeries

時間経過におけるアプリケーション使用統計とフローパフォーマンス指標を提供します。

アプリケーションモニタリング、ネットワークパフォーマンス分析、使用レポート。

セキュリティインシデント/アラート

stories

セキュリティインシデントと関連アラートに関する高レベルのインサイト。

SOCワークフロー、インシデント管理、アラートの強化。

トラフィックメトリック

accountMetrics

サイトおよびリモートユーザー全体のトラフィックと使用メトリック。

ネットワーク使用分析、容量計画、およびレポートダッシュボード。

接続性&インベントリスナップショット

accountSnapshot

接続ステータスおよびサイト、ソケット、ユーザーのインベントリ情報。

インフラストラクチャモニタリング、トポロジー可視性、環境の発見。

デバイスインベントリ&アトリビュート

devices.attributesCatalog

devices.list

プラットフォームによって発見されたデバイスインベントリと関連アトリビュートを提供します。

アセット管理システム、IoT/OTの可視性、デバイス分類、インベントリトラッキング。

ソケットポートメトリック

socketPortMetrics

socketPortMetricsTimeSeries

ソケットインターフェースおよびポートの現在と過去のメトリックを提供します。

インフラストラクチャモニタリング、リンクの健康モニタリング、容量計画、ネットワークトラブルシューティング。

完全なAPI操作の定義とサンプル応答については、Cato GraphQL APIリファレンスを参照ください。 

リファレンスツールと例

開発と統合ワークフローをサポートするために、Catoはいくつかのリファレンスリソースを提供します:

  • Cato GitHubアカウント - サンプルコード、APIヘルパーツール、Jupyterノートブック、Postmanコレクション、およびCLIユーティリティ。 例:

  • データ分析 - eventsFeedのユースケースを示すJupyterノートブック。

  • cato-toolbox - Pythonでイベントを取得するコードを含む、API消費およびテストのための汎用ヘルパー。

  • GraphQL Playground - APIクエリのテスト用ブラウザベースのインタラクティブツール。 詳細は、GraphQL PlaygroundからのCato API接続を参照してください。

  • CatoリモートMCPサーバー - モデルコンテキストプロトコル(MCP)を介してAIアシスタントやLLMベースのツールを使用してCato APIと統合できます。 これにより、自然言語またはAI駆動型ワークフローを使用してCatoデータとのやり取りが可能になります。 詳細については、Cato Remote MCPサーバーとの作業をご覧ください。

サポートとコミュニティリソース

パートナーは、API関連の質問を通じて提起できます。