コンテンツにスキップ

コレクターGraphQL APIの利用開始🔗

重要

先に、API認証の手順を完了し、動作するclient_idとclient_secretを取得してください。

地域

XDR APIにアクセスするためのURLは、お客様の環境が展開されているリージョンによって異なる場合があります。

  • US1— https://api.ctpx.secureworks.com
  • US2— https://api.delta.taegis.secureworks.com
  • US3— https://api.foxtrot.taegis.secureworks.com
  • EU1— https://api.echo.taegis.secureworks.com
  • EU2— https://api.golf.taegis.secureworks.com

このXDR APIドキュメントの例では、https://api.ctpx.secureworks.com を使用しています。別のリージョンをご利用の場合は、適切なURLに置き換えてください。

Secureworks® Taegis™ XDRコレクターAPIを使用して、データコレクターのクエリや、展開状況、エンドポイント、構成および正常性の状態などの一般情報を取得できます。これらのAPIでは、コレクターおよび関連するアトリビュートの作成、更新、削除も可能です。利用可能なすべてのコレクターAPIエンドポイントは、Collector GraphQL APIおよびDatasource GraphQL APIリファレンスで確認できます。

注意事項🔗

  • Taegis™ XDR Collectorの機能について事前知識が必要です。XDR Collectorの詳細はオンプレミスデータコレクターをご覧ください。
  • APIの観点では、コレクターはシングルノードクラスタに対応します。現在、本ドキュメント内では_クラスタ_と_コレクター_という用語を同義で使用しています。
  • 各コレクターには、デフォルトで_role_タグ（初期値は_collector_）が付与されています。これらの_role_タグは、コレクターにインストールされているHelmチャートのセットを示します。コレクターの現在の_role_に関わらず、カスタム展開やエンドポイントの追加は常に可能ですが、標準外のロールはテストや特殊なセットアップ以外では推奨されていません。

コレクターの作成🔗

mutation createCluster($clusterInput: ClusterInput! = { name: "sample-collector" description: "a collector created from a script!" network: { dhcp: true, hostname: "sample-collector-host" } })
{
    createCluster(clusterInput: $clusterInput)
    {
        createdAt updatedAt id role name type clusterType description network { dhcp hostname hosts address mask gateway dns ntp proxy } deployments { createdAt updatedAt id role name description chart version config status { name createdAt updatedAt id status } endpoints { createdAt updatedAt id description address port validity { from until } credentials } } status { name createdAt updatedAt id status } health healthState registration { id region } maintenanceDay maintenanceStartHour maintenanceDuration clusterNodes { createdAt updatedAt id name description network { dhcp hostname hosts address mask gateway dns ntp proxy } health registration { id region } host } isHa haCidrBlock
    }
}

コレクターのクエリ🔗

query getAllClusters($role: String! = "collectors")
{
    getAllClusters(role: $role)
    {
        createdAt updatedAt id role name type clusterType description network { dhcp hostname hosts address mask gateway dns ntp proxy } deployments { createdAt updatedAt id role name description chart version config status { name createdAt updatedAt id status } endpoints { createdAt updatedAt id description address port validity { from until } credentials } } status { name createdAt updatedAt id status } health healthState registration { id region } maintenanceDay maintenanceStartHour maintenanceDuration clusterNodes { createdAt updatedAt id name description network { dhcp hostname hosts address mask gateway dns ntp proxy } health registration { id region } host } isHa haCidrBlock
    }
}

注意

一部のユーザーは、endpointsセクションからcredentialsを削除する必要がある場合があります。

次のステップ🔗

詳細については、Collector GraphQL APIおよびDatasource GraphQL APIのドキュメントをご参照ください。