Search
K
GitHub v3 REST API

code-scanning-analysis-tool

object
namestring

The name of the tool used to generate the code scanning analysis.

versionstring

The version of the tool used to generate the code scanning analysis.

guidstring

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

Example

code-scanning-analysis-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.

code-scanning-alert-environment

string

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

code-scanning-analysis-category

string

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.

code-scanning-alert-location

object

Describe a region within a file for the alert.

pathstring
start_lineinteger
end_lineinteger
start_columninteger
end_columninteger
Example