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

2026年8月30日より、API全体で厳密なタイプの検証を実施し、文書化されたスキーマと一致させます。 API コールでフィールドのドキュメント化されたタイプと一致しない形式で値が渡される場合、エンドポイントによって影響を受ける可能性があります。

• 変更点： パラメーターは、スキーマで定義されたタイプと正確に一致する必要があります。 例えば、Int 項目は整数値のみ許可されます。文字列入力 "5" は今後受け入れられません。 これは Int 項目に限らず、ドキュメントに記載されたタイプと一致しない形式で渡されるパラメーターには影響があります。

• 2026年8月30日までにあなたがするべきこと：

  • 記録されたスキーマタイプと一致しない形式で渡された値に対して、APIコールを見直してください（例：文字列として渡される数値）。

  • 不一致のコールをすべて更新してください。

現在、CatoのAPIゲートウェイはIDフィールドを文字列またはLong（整数）として返すことがあります。 今後のインフラ更新の一環として、すべてのIDフィールドは一貫して文字列として返されるようになります。

• 何が変わるのか：以前にIDフィールドを数値のLong値（例えば、1000000002）として返していたAPIの応答が、今後は常に文字列（例えば、"1000000002"）として返されるようになります。

• 影響を受ける人：IDフィールドをLong/整数型として扱っているAPIクライアントは、変更が導入されたときに問題が発生する可能性があります。

• 2026年6月21日までに何をすべきか：IDフィールドに対し、Long型とString型の両方を承認するように、クライアントコードを更新してください。 これにより、変更が効果的に行われた際に中断を防ぎ、スムーズな移行を確実にします。

2025年8月10日、addAdminおよびupdateAdmin APIの電子メール項目がオプション（null許可）になりました。 この変更は、スクリプトやサービスプリンシパルを使用したオートメーションを含む、細かいAPIアクセス制御をサポートする今後のインフラに対応しています。

• 現在および将来の管理者は常に電子メール値を含めなければなりません

• 人間の管理者のみを返すクエリには影響がありません。

• 一部のクライアントは、addAdminPayloadなどの応答ペイロードでのnull値を処理する必要があります

これは通常の破壊的変更ではありませんが、電子メールが常に存在すると仮定しているクライアントに影響する可能性があります。 統合をレビューして問題を回避してください。

eventsFeed APIはマーカーを使用してイベントフィードを繰り返し取り込むことを有効にします。 マーカーフィールドは、新しい反復の開始を示す識別子を表示します。 APIは一意のマーカーフィールドに基づいてキューからイベントを読むと応答に次のマーカーロケーションを提供します。 キューに新しいイベントがない場合、マーカーフィールドは空です

代替のイベント消費モデルとして、直接のノーコード統合を使用することもでき、AWS S3とのCatoイベント統合およびAzureストレージアカウントとのCatoイベント統合をご覧ください。

何を変更しましたか？

• 以前は、マーカーが指定されていないと、APIは利用可能な最も古いマーカーを返しました。 これにより、最新のイベントに到達するまでに全イベントキューを消費する必要がありました。

• 2025年4月27日以降、マーカーが指定されていない場合、APIは最新のマーカーを返します。 このことにより、APIは最新のイベントを直接取得できます。

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

• eventsFeed APIのほとんどのユースケースには影響がありません。 マーカーフィールドをクエリで使用する場合、消費ロジックに変更はなく、イベントフィードの操作は同じです。

• キューを消費して最近のイベントに到達するため専用のロジックがある場合、そのロジックはもはや必要ありません。

  • 現在、入力マーカーが指定されていない場合、APIは最新のマーカーを提供します。 このマーカーを使用してAPIを呼び出すと、最新のイベントが取得されます

  • API応答はキューの最上部（最近）の場所を指すマーカーを含んでいます

  • 対応するスクリプトと自動プロセスは更新する必要があります

limitフィールドの機能を変更し、limit=0がサポートされなくなりました。これはベストプラクティスとみなされません。 継続したスムーズな運用を保証するため、このパラメータに依存するスクリプトやクエリを更新する必要があります。 代わりに、APIが完全にサポートする1-2000の範囲で制限を設定できます。

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

EventFieldName APIのsecondary_socket_serialイベントフィールドは、廃止予定としてマークされ、2026年3月18日にEoLに達しました。

推奨される代替フィールド: socket_serial

LastMileBWInput APIの項目とタイプは、廃止予定としてマークされ、2025年6月30日にEoLに達しました。

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

InterfaceInfo APIの項目とタイプは、廃止予定としてマークされ、2025年6月30日にEoLに達しました。

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

SocketInterfaceBandwidthInput APIの項目とタイプは、廃止予定としてマークされ、2025年6月30日にEoLに達しました。

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

• auditFeedクエリAPIは、AuditFieldFilterInputタイプを使用してフィルターのリストを受け入れます。 各フィルターにはAuditFieldNameとEventFieldNameの二つの入力フィールドを含むFieldNameInputタイプで定義されたfieldNameが含まれます。

• しかし、AuditFieldNameのみが有効でサポートされている入力フィールドです。 スキーマの明確さを改善し、混乱を避けるため、2025年6月8日にスキーマからEventFieldName項目が削除されました。

• AuditFieldName入力フィールドのみを使用するように、auditFeedフィルターを使用するすべてのスクリプトとクエリを更新してください。

EventFieldName APIの項目とタイプは、廃止予定としてマークされ、2025年5月1日にEoLに達しました。

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

EventFieldName APIのbgp_peer_description項目は、廃止予定としてマークされ、2025年4月15日にEoLです。

EventFieldName APIの項目とタイプは、廃止予定としてマークされ、2025年3月1日にEoLです。

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

次の 項目 は StoryDrillDownFilter Beta API において非推奨マークされました。2025年2月23日をもってすべて廃止されます。

代わりに推奨される項目とタイプを使用してください。

Cato クライアントに関連するいくつかのサブタイプ値のEoLの発表後、アイルランド CMA 位置（cc.catonetworks.com）を使用しているアカウントのために、以下の項目で展開が一時停止されています。

• 詳細はCMA - 技術ガイドラインを参照してください

Catoクライアントに関連する次の項目とタイプが非推奨とされ、2025年1月2日よりEoLになります。

代わりに推奨される項目とタイプを使用してください。

• 詳細情報は以下の記事を参照： Cato イベントデータ の 一部サブタイプ の EoL