CSV、JSON、または SARIF へのデータのエクスポート

このセクションでは、スキャン結果を CSV、JSON、または SARIF としてエクスポートする方法について説明します。

ASoC API はデフォルトで JSON でデータを返します。これはプログラムによる利用に便利です。明示的に JSON を要求するには、以下のヘッダーを送信します。

Accept: application/json

CSV (スプレッドシート用) のデータが必要な場合は、以下を送信して CSV を要求します。

Accept: text/csv

注: ASoC API は、返されるフィールドのフィルタリングと選択のためにOData V4 ($filter,$select) をサポートしています。これは JSON と CSV の両方のレスポンスに適用されます。

SARIF の場合: UI には SAST 問題について SARIF を生成できるエクスポート・ダイアログがあります (製品のエクスポート・ダイアログを参照)。API を介してプログラムで SARIF を生成する必要がある場合、SARIF 出力は Reports API (OData/export エンドポイントとは異なるエンドポイント) によって生成されます。API の例とパラメーターについては、「SARIF へのデータのエクスポート」を参照してください。

API の使用

API を使用するには有効なアクセス・トークンが必要ですが、アクセス・トークンを取得するには、アカウントに関連付けられた API キーが必要です。詳細については、「API キーの生成」を参照してください。

Swagger

データを CSV 形式で取得するには、「実行」ボタンをクリックする前に、デフォルトの「応答コンテンツ・タイプ」を「application/json」から「text/csv」に変更します。

詳しくは、Swagger の資料を参照してください。

curl

以下に示すのは、アカウントからアクセスできるすべてのアプリケーションのすべてのプロパティーを返す curl コマンドの例です (<access token> を有効なアクセス・トークンに置き換えてください)。

curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://cloud.appscan.com/api/v4/Apps'

API は OData をサポートしているため、$filter および $select 要求パラメーターを使用して、データの一部を取得できます。以下の例では、リスク等級の高いアプリケーションだけが取得され、各アプリケーションには「ID」、「名前」、および「リスク等級」の 3 つのプロパティーが含まれています。

curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://cloud.appscan.com/api/v4/Apps?
                    $filter=RiskRating%20eq%20'\''High'\''&$select=Id%2CName%2CRiskRating'

以下も参照してください。

CSV 形式