Get a code scanning analysis for a repository

GET

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

Gets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The rules_count field in the default 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.

This endpoint supports the following custom media types. For more information, see "Media types."

application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

リクエストパラメータ

パスパラメータ

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟠403Forbidden

🟠404Record Not Found

🔴503Service Unavailable

リクエストExample

Shell

JavaScript

Java

Swift

curl --location 'https://service1.exmaple.com/repos///code-scanning/analyses/'

レスポンスExample

200 - application/json response

{
    "ref": "refs/heads/main",
    "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
    "analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
    "environment": "{\"language\":\"javascript\"}",
    "error": "",
    "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript",
    "created_at": "2021-01-13T11:55:49Z",
    "results_count": 3,
    "rules_count": 67,
    "id": 3602840,
    "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
    "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
    "tool": {
        "name": "CodeQL",
        "guid": null,
        "version": "2.4.0"
    },
    "deletable": true,
    "warning": ""
}

更新日時 2025-06-12 06:47:19

List code scanning analyses for a repository

Delete a code scanning analysis from a repository