Search
K
GitHub v3 REST API

code-scanning-alert-rule-summary

object
idstring

A unique identifier for the rule used to detect the alert.

namestring

The name of the rule used to detect the alert.

severitystring

The severity of the alert.

Allowed values:nonenotewarningerror

descriptionstring

A short description of the rule used to detect the alert.

Example

code-scanning-analysis-tool-version

string

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

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.