コンテンツにスキップ

コレクター 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
  • EU— https://api.echo.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の観点では、コレクターはシングルノードクラスタに対応します。現在、クラスタ と コレクター という用語はここでは同義で使用されています。
  • 各コレクターには、デフォルトで collector となる role タグが関連付けられています。これらの 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 のドキュメントを参照してください。