List code scanning analyses for a repository

GET

/repos/{owner}/{repo}/code-scanning/analyses

Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the page and per_page parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The rules_count field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and 0 is returned in this field.

You must use an access token with the security_events scope to use this endpoint.
GitHub Apps must have the security_events read permission to use this endpoint.

Deprecation notice:
The tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Query 参数

返回响应

🟢200Response

application/json

Bodyapplication/json

🟠403403

🟠404404

🔴503503

请求示例

Shell

JavaScript

Java

Swift

curl --location 'https://api.github.com/repos///code-scanning/analyses' \
--header 'Authorization: Bearer <token>'

响应示例

200 - 示例 1

[
    {
        "analysis_key": "string",
        "category": "string",
        "commit_sha": "stringstringstringstringstringstringstri",
        "created_at": "2019-08-24T14:15:22.123Z",
        "deletable": true,
        "environment": "string",
        "error": "error reading field xyz",
        "id": 0,
        "ref": "string",
        "results_count": 0,
        "rules_count": 0,
        "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
        "tool": {
            "guid": "string",
            "name": "string",
            "version": "string"
        },
        "url": "http://example.com",
        "warning": "123 results were ignored"
    }
]

修改于 2022-08-24 13:05:06

Update a code scanning alert

Upload an analysis as SARIF data