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.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///code-scanning/analyses'

响应示例

200 - 示例 1

[
    {
        "analysis_key": "string",
        "category": "string",
        "commit_sha": "stringstringstringstringstringstringstri",
        "created_at": "2019-08-24T14:15:22Z",
        "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"
    }
]

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

owner

string

必需

repo

string

必需

Query 参数

tool_name

string

可选

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

tool_guid

string

可选

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

page

integer

可选

Page number of the results to fetch.

per_page

integer

可选

Results per page (max 100).

ref

string

可选

The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

sarif_id

string

可选

Filter analyses belonging to the same SARIF upload.

返回响应

🟢200Response

application/json

Body

array of:

analysis_key

string

必需

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.