Sample - GitHub REST API
GET/advisories/{ghsa_id}

Get a global security advisory

Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
ghsa_idstringrequired
The GHSA (GitHub Security Advisory) identifier of the advisory.

2 status codes
200Response
ghsa_idstringrequired
The GitHub Security Advisory ID.
cve_idstringrequired
The Common Vulnerabilities and Exposures (CVE) ID.
urlstringrequired
The API URL for the advisory.
html_urlstringrequired
The URL for the advisory.
repository_advisory_urlstringrequired
The API URL for the repository advisory.
summarystringrequired
A short summary of the advisory.
descriptionstringrequired
A detailed description of what the advisory entails.
typestringrequired
The type of advisory.
Allowed:reviewedunreviewedmalware
severitystringrequired
The severity of the advisory.
Allowed:criticalhighmediumlowunknown
source_code_locationstringrequired
The URL of the advisory's source code.
identifiersarray<object>required
referencesarray<string>required
published_atstringrequired
The date and time of when the advisory was published, in ISO 8601 format.
updated_atstringrequired
The date and time of when the advisory was last updated, in ISO 8601 format.
github_reviewed_atstringrequired
The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
nvd_published_atstringrequired
The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. This field is only populated when the advisory is imported from the National Vulnerability Database.
withdrawn_atstringrequired
The date and time of when the advisory was withdrawn, in ISO 8601 format.
vulnerabilitiesarray<object>required
The products and respective version ranges affected by the advisory.
cvssobjectrequired
cvss_severitiesobjectoptional
epssobjectoptional
The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).
cwesarray<object>required
creditsarray<object>required
The users who contributed to the advisory.
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.