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 with private repos,
the public_repo scope also grants permission to read security events on public repos only.
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.

Request

Path Params

Query Params

Responses

🟢200Response

application/json

Body

🟠403403

🟠404404

🔴503503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 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"
    }
]

Modified at 2023-08-15 02:59:30

List instances of a code scanning alert

Delete a code scanning analysis from a repository