alert_instances

Creates, updates, deletes, gets or lists an alert_instances resource.

Overview

Name	alert_instances
Type	Resource
Id	github.code_scanning.alert_instances

Fields

The following fields are returned by SELECT queries:

list_alert_instances

Response

Name	Datatype	Description
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.
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.
classifications	array	Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.
commit_sha	string
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.
html_url	string
location	object	Describe a region within a file for the alert.
message	object
ref	string	The Git reference, formatted as refs/pull/<number>/merge, refs/pull/<number>/head, refs/heads/<branch name> or simply <branch name>.
state	string	State of a code scanning alert instance. (open, fixed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_alert_instances	select	owner, repo, alert_number	page, per_page, ref, pr	Lists all instances of the specified code scanning alert. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alert_number	integer	The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
pr	integer	The number of the pull request for the results you want to list.
ref	string	The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

SELECT examples

list_alert_instances

Lists all instances of the specified code scanning alert.

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.

SELECT
analysis_key,
category,
classifications,
commit_sha,
environment,
html_url,
location,
message,
ref,
state
FROM github.code_scanning.alert_instances
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND alert_number = '{{ alert_number }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND ref = '{{ ref }}'
AND pr = '{{ pr }}'
;