alerts

Overview

Name	alerts
Type	Resource
Id	github.dependabot.alerts

Fields

Name	Datatype	Description
auto_dismissed_at	string	The time that the alert was auto-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.
dependency	object	Details for the vulnerable dependency.
dismissed_at	string	The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dismissed_by	object	A GitHub user.
dismissed_comment	string	An optional comment associated with the alert's dismissal.
dismissed_reason	string	The reason that the alert was dismissed.
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.
html_url	string	The GitHub URL of the alert resource.
number	integer	The security alert number.
security_advisory	object	Details for the GitHub Security Advisory.
security_vulnerability	object	Details pertaining to one vulnerable version range for the advisory.
state	string	The state of the Dependabot alert.
updated_at	string	The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
url	string	The REST API URL of the alert resource.

Methods

Name	Accessible by	Required Params	Description
get_alert	SELECT	alert_number, owner, repo	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 Dependabot alerts read permission to use this endpoint.
list_alerts_for_repo	SELECT	owner, repo	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 Dependabot alerts read permission to use this endpoint.
update_alert	EXEC	alert_number, owner, repo, data__state	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 Dependabot alerts write permission to use this endpoint. To use this endpoint, you must have access to security alerts for the repository. For more information, see "Granting access to security alerts."