対話式 API 文書ページへのアクセス

対話式 API 文書ページを使用して、RESTful API の技術的な詳細にアクセスし、サーバーに対する API 要求の実行を試すことができます。

このタスクについて

API 文書ユーザー・インターフェースは、以下の REST API インターフェースの説明と、これらを使用する機能を提供します。
表 1. REST API インターフェース
REST API 説明
/api/analytics ルールのカスタム・アクションを作成、更新、および削除します。
/api/ariel イベントおよびフローのプロパティーの表示、イベントおよびフローの検索の作成、検索の管理を行います。
/api/asset_model モデル内のすべてのアセットのリストを返します。 使用可能なすべてのアセット・プロパティー・タイプと保存済み検索をリスト表示したり、アセットを更新したりすることもできます。

バージョン 24.0 の UP11 から、アセットを作成することもできます。

バージョン 26.0 の UP13 から、製品詳細を含むアセットのリストを取得し、アセットを削除できます。
/api/auth 現行セッションをログアウトし、無効化する。
/api/config テナント、ドメイン、および QRadar 拡張を表示および管理します。
/api/data_classification すべての上位カテゴリーと下位カテゴリー、 QRadar Identifier (QID) レコード、およびイベント・マッピングを表示します。 QID レコードおよびマッピングを作成または編集することもできます。
/api/forensics キャプチャー・リカバリーおよびケースを管理します。
/api/gui_app_framework GUI アプリケーション・フレームワーク Software Development Kit を使用して作成されるアプリケーションをインストールおよび管理します。
/api/help API 機能のリストに戻る。
/api/qrm QRM 保存済み検索グループ、質問グループ、シミュレーション・グループ、トポロジーの保存済み検索グループ、およびモデル・グループを管理します。
/api/qvm アセット、脆弱性、ネットワーク、オープン・サービス、フィルターを取得します。 修復チケットの作成や更新を行うこともできます。
/api/reference_data リファレンス・データ収集の表示と管理を行います。
/api/scanner スキャン・プロファイルに関連するリモート・スキャンの表示、作成、開始を行います。
重要: IBM QRadar Vulnerability Manager スキャナーは、 7.5.0 Update Package 6 の耐用年数終了 (EOL) であり、どのバージョンの IBM QRadarでもサポートされなくなりました。 詳細については、 QRadar Vulnerability Manager: サポート終了製品のお知らせ ( https://www.ibm.com/support/pages/node/6853425 ) を参照してください。
/api/services WHOIS ルックアップ、ポート・スキャン・ルックアップ、DNS ルックアップ、DIG ルックアップなどのタスクを実行します。 また、1 つの IP または IP アドレスのセットの地理位置情報データを取得することもできます。
/api/siem オフェンスを表示、更新、クローズします。 メモの追加およびオフェンスのクローズ理由の管理も行えます。
/api/staged_config ユーザー、ホスト、通知、リモート・ネットワーク、およびリモート・サービスのステージング済み構成を取得します。 また、デプロイ・アクションの状態の開始や確認、および Yara ルールの更新と削除もできます。
/api/system サーバー・ホスト、ネットワーク・インターフェース、およびファイアウォール・ルールを管理します。

手順

  1. インタラクティブなAPIドキュメントインターフェースにアクセスするには、次の URL をウェブブラウザに入力してください： https://ConsoleIPaddress/api_doc/。
  2. 使用する API バージョンをリストから選択します。
  3. アクセスするエンドポイントに移動します。
  4. エンドポイントの文書を読み、要求パラメーターを入力します。
  5. 「試してみる」 をクリックすると、コンソールにAPIリクエストが送信され、適切にフォーマットされた HTTPS の応答が返されます。
    注: 「試行する (Try it out)」をクリックすると、 QRadar システムでアクションが実行されます。 一部のアクションは元に戻せません。例えば、クローズしたオフェンスを再オープンすることはできません。
  6. QRadarと統合するために必要な情報を確認して収集します。