Skip to main content

alert_instances

Overview

Namealert_instances
TypeResource
Idgithub.code_scanning.alert_instances

Fields

NameDatatypeDescription
categorystringIdentifies 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.
locationobjectDescribe a region within a file for the alert.
messageobject
analysis_keystringIdentifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
environmentstringIdentifies 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.
statestringState of a code scanning alert.
classificationsarrayClassifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
html_urlstring
commit_shastring
refstringThe full Git reference, formatted as refs/heads/<branch name>,
refs/pull/<number>/merge, or refs/pull/<number>/head.

Methods

NameAccessible byRequired Params
list_alert_instancesSELECTalert_number, owner, repo