v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-07-147873273.9 MB

code-scanning

Get a code scanning analysis for a repository

Gets a specified code scanning analysis for a repository. 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.

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.

If you use the Accept header application/sarif+json, the response contains the analysis data that was uploaded. This is formatted as SARIF version 2.1.0.

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

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

analysis_idinteger required

The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.

Response

refstring required

The full Git reference, formatted as refs/heads/<branch name>, refs/pull/<number>/merge, or refs/pull/<number>/head.

commit_shastring required

The SHA of the commit to which the analysis you are uploading relates.

analysis_keystring required

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

environmentstring required

Identifies the variable values associated with the environment in which this analysis was performed.

categorystring

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.

errorstring required

created_atstring date-time required

The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

results_countinteger required

The total number of results in the analysis.

rules_countinteger required

The total number of rules used in the analysis.

idinteger required

Unique identifier for this analysis.

urlstring uri required

The REST API URL of the analysis resource.

sarif_idstring required

An identifier for the upload.

deletableboolean required

warningstring required

Warning generated when processing the analysis

Example response

{
  "error": "error reading field xyz",
  "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
  "warning": "123 results were ignored"
}