将数据导出为 CSV、JSON 或 SARIF

本节介绍了如何将扫描结果导出为 CSV、JSON 或 SARIF。

缺省情况下,AppScan 360° API 会以 JSON 格式返回数据,这对于程序化调用非常有用。要明确请求 JSON,请发送以下标头:
Accept: application/json
如果您需要 CSV 格式的数据(用于电子表格),请通过发送以下内容来请求 CSV:
Accept: text/csv
注:AppScan 360° API 支持使用 OData V4 ($filter, $select) 对返回的字段进行过滤和选择;这适用于 JSON 和 CSV 格式的响应。

对于 SARIF:UI 提供了一个“导出”对话框,该对话框可为 SAST 问题生成 SARIF 格式的数据(请参阅产品中的“导出”对话框)。如果您需要通过 API 以编程方式生成 SARIF,SARIF 输出将由 Reports API(与 OData/导出端点不同的端点)生成。有关 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://<360domain>/api/v4/Apps'
由于 API 支持 OData,因此您可以利用 $filter 和 $select 请求参数来获取部分数据。在以下示例中,仅检索具有高风险分级的应用程序,并且每个应用程序包含 3 个属性 - Id、Name 和 RiskRating:
curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://<360domain>/api/v4/Apps?
                    $filter=RiskRating%20eq%20'\''High'\''&$select=Id%2CName%2CRiskRating' 

另请参阅:

CSV 格式