Cato APIの潜在的な破壊的変更とEoL

この記事は、Cato GraphQL APIスキーマの潜在的な破壊的変更およびEoLのお知らせのためのプラットフォームであり、APIクライアントの更新を必要とする情報を含みます。

この記事で使用されているライセンス期間の用語は、Cato APIとは何かで説明されています。

Cato APIを使用しているお客様には、このAPIに関する破壊的変更についての記事の更新情報をメールで自動的に受信するために、フォローをクリックすることをお勧めします。 新規および更新済みAPIに関する詳細は、Cato API変更ログで確認できます。

APIについての詳細は、Cato Networks GraphQL API Referenceを参照してください。

潜在的な変更履歴

2026-06-21 - API ID項目: タイプの変更、長整数から文字列

現在、CatoのAPIゲートウェイはID項目を文字列または長整数として返すことがあります。 今後のインフラ更新の一環として、すべてのID項目は一貫して文字列として返されます。

  • 何が変わるのか: 以前はID項目を数値の長整数値として返していたAPI応答が、今後は常に文字列として返されます(例: "1000000002")。
  • 影響を受けるのは誰か: この変更が実施されると、ID項目を長整数型として扱うAPIクライアントが正常に動作しなくなる可能性があります。
  • 2026年6月21日までにすべきこと: ID項目のためにAPIクライアントコードを長整数と文字列タイプの両方を受け入れるよう更新してください。 これにより円滑な移行が確保され、変更が有効になるときに混乱が発生するのを防ぐことができます。

2025-08-10 - addAdminとupdateAdmin APIのメール項目の変更

2025年8月10日、addAdminおよびupdateAdmin APIのemail項目はオプション(null許容)になりました。 この変更は、サービスプリンシパルを使用したスクリプトおよび自動化を含む、細かいAPIアクセスコントロールをサポートする今後のインフラストラクチャをサポートします。

  • 現在および将来の人間の管理者は常に電子メール値を含む必要があります
  • 人間の管理者のみを返すクエリは影響を受けません。
  • 一部のクライアントはaddAdmin項目などの応答ペイロードでnull値を処理する必要があるかもしれません

これは通常は破壊的変更ではありませんが、emailが常に存在すると仮定するクライアントに影響を与える可能性があります。 問題を避けるために、統合を見直してください。

2025-04-27 - eventsFeedクエリAPIが最新のイベントの取得をサポート

eventsFeed APIはマーカーを使用してイベントフィードの反復的な取得を可能にします。 Markerフィールドは、新しい反復の開始を示す識別子を示します。 APIは一意のMarkerフィールドに基づいてキューからイベントを読み取り、応答には次のマーケーションの場所を提供します。 キューに新しいイベントがない場合、Markerフィールドは空になります

イベント消費モデルの代替として、直接の無コード統合を使用できます。詳細はCato EventsとAWS S3の統合およびCato EventsとAzure ストレージアカウントの統合を参照してください。

何を変更しましたか? 

  • 以前はマーカーが指定されていないと、APIは利用可能な最も古いマーカーを返していました。 これは最も最近のイベントに到達する前にイベントキュー全体を消費する必要がありました。
  • 2025年4月27日から、マーカーが指定されていない場合、APIは最新のマーカーを返します。 これにより、APIは最新のイベントを直接取得できます。

これは破壊的変更ですか? 

  • eventsFeed APIのほとんどの使用例には影響はありません。 マーカー項目がクエリに使用されるときは変更がなく、イベントフィード消費論理は同じです。
  • キューを消費して最近のイベントに到達するための専用のロジックがある場合、そのロジックは不要になりました。

    • 現在、入力マーカーが指定されていない場合、APIは最新のマーカーを提供します。 このマーカーを使用してAPIを呼び出すと最新のイベントを取得します
    • API応答には、最新の(キューのトップ)場所を指すマーカーが含まれています
    • 該当するスクリプトと自動プロセスを更新する必要がある

2025-02-09 - XDR APIの変更、limit=0はサポートされなくなりました

limitフィールドの機能を変更し、limit=0がサポートされなくなったため、これがベストプラクティスと見なされないことが理由です。 円滑な運用を続けるために、このパラメータに依存しているスクリプトやクエリを更新する必要があります。 代わりに、APIが完全にサポートする1から2000の間の制限を設定できます。

すべてのストーリーを取得する必要がある場合、ページネーションアプローチの使用をお勧めします。

近日公開のサポート終了発表

 

以前のEoLのお知らせ

2026-03-18 - SecondarySocketSerial項目のEoL

secondary_socket_serialイベント項目は、EventFieldName APIで現在廃止扱いとなっており、2026年3月18日に終息(EoL)しました。

推奨される代替項目: socket_serial

2025-06-30 - LastMileBwInput、InterfaceInfo、およびSocketInterfaceBandwidthInputタイプのEoL

次のフィールドとタイプは、LastMileBWInput APIで現在廃止扱いとなっており、2025年6月30日に終息(EoL)しました。

代わりに推奨されるフィールドとタイプを使用してください。

非推奨タイプ 推奨タイプ
downstream downstreamMbpsPrecision
upstream upstreamMbpsPrecision

次のフィールドとタイプは、InterfaceInfo APIで現在廃止扱いとなっており、2025年6月30日に終息(EoL)しました。

代わりに推奨されるフィールドとタイプを使用してください。

非推奨タイプ 推奨タイプ
downstreamBandwidth downstreamBandwidthMbpsPrecision
upstreamBandwidth upstreamBandwidthMbpsPrecision

次のフィールドとタイプは、SocketInterfaceBandwidthInput APIで現在廃止扱いとなっており、2025年6月30日に終息(EoL)しました。

代わりに推奨されるフィールドとタイプを使用してください。

非推奨タイプ 推奨タイプ
downstreamBandwidth downstreamBandwidthMbpsPrecision
upstreamBandwidth upstreamBandwidthMbpsPrecision

2025-06-08 - FieldNameInput内のEventFieldName項目のEoL

  • auditFeedクエリAPIは、AuditFieldFilterInputタイプを使用してフィルターのリストを受け入れます。 各フィルターは、タイプFieldNameInputで定義されたfieldNameを含んでおり、現在2つの入力項目を含みます: AuditFieldNameEventFieldName
  • しかし、AuditFieldNameだけが有効かつサポートされている入力フィールドです。 スキーマの明確さを向上させるために、EventFieldName項目は2025年6月8日にスキーマから削除されました。
  • auditFeedフィルターを使用するすべてのスクリプトとクエリを更新して、AuditFieldName入力フィールドのみを使用してください。

2025-05-01 - EventFieldNameタイプのEoL

次のフィールドとタイプは、EventFieldName APIで現在廃止扱いとなっており、2025年5月1日に終息(EoL)しました。

代わりに推奨されるフィールドとタイプを使用してください。

非推奨タイプ 推奨タイプ
アプリケーション application_id/application_name
custom_categories custom_category_id/custom_category_name
custom_category custom_category_id/custom_category_name
宛先サイト 宛先サイトID/宛先サイト名
デバイス姿勢プロファイル デバイス姿勢プロファイル
内部ID イベントID
ルール ルール名
送信元サイト 送信元サイトID/送信元サイト名

2025-04-15 - bgp_peer_descriptionのEoL

EventFieldName API内のbgp_peer_descriptionフィールドは廃止予定になり、2025年4月15日をもって商用計画となります。

2025-03-01 - EventFieldNameタイプのEoL

EventFieldName APIの項目とタイプは、非推奨としてマークされており、2025年3月1日時点でサポート終了となりました。

代わりに推奨されるフィールドとタイプを使用してください。

廃止予定タイプ 推奨された種類
parent_pid src_process_parent_pid
pid src_pid
process_path src_process_path

2025-02-23 - StoryDrillDownFilter値項目のEoL

StoryDrillDownFilter Beta APIの項目は、非推奨としてマークされており、2025年2月23日時点でサポート終了となりました。

代わりに推奨されたフィールドと種類を使用してください。

非推奨種類 推奨された種類

2025-02-11 - Catoイベントデータの一部サブタイプのEoL

Catoクライアントに関連するイベント消費APIで使用されている一部のサブタイプ値のEoL発表発表に続いて、以下の項目に対してはアイルランドCMAロケーション(cc.catonetworks.com)を使用するアカウントでの展開が一時停止されています。

非推奨種類 推奨された種類
再接続されています 接続または切断されています
PoPが変更されました

接続または切断されています

(PoP名はlastPopName項目に返されます。)

2025-01-02 - イベントサブタイプのEoL

Catoクライアントに関連する以下のフィールドと種類が非推奨としてマークされ、2025年1月2日に寿命終了 (EoL) となります。

代わりに推奨されたフィールドと種類を使用してください。

非推奨種類 推奨された種類 注意
VPN Never-Off-Bypass Always-On バイパス VPN Never-Off-Bypass サブタイプ値が Always-On バイパス値に置き換えられています
再接続されています 接続済みまたは切断 粒度を増やすために、再接続サブタイプ値が2つの新しい値、接続および切断に分割されています
PoPが変更されました

接続または切断されています

(PoP名はlastPopName項目に返されます)

粒度を増やすために、PoPが変更されましたサブタイプ値が2つの新しい値、接続および切断に分割されています

この記事は役に立ちましたか?

1人中0人がこの記事が役に立ったと言っています

0件のコメント