alerts

Overview

Name	alerts
Type	Resource
Id	github.code_scanning.alerts

Fields

Name	Datatype	Description
dismissed_at	string	The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
created_at	string	The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
rule	object
tool	object
fixed_at	string	The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
instances_url	string	The REST API URL for fetching the list of instances for an alert.
number	integer	The security alert number.
url	string	The REST API URL of the alert resource.
most_recent_instance	object
html_url	string	The GitHub URL of the alert resource.
updated_at	string	The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
state	string	State of a code scanning alert.
dismissed_reason	string	Required when the state is dismissed. The reason for dismissing or closing the alert.
dismissed_by	object	A GitHub user.
dismissed_comment	string	The dismissal comment associated with the dismissal of the alert.

Methods

Name	Accessible by	Required Params	Description
get_alert	SELECT	alert_number, owner, repo	Gets a single code scanning alert. 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.
update_alert	EXEC	alert_number, owner, repo, data__state	Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.