Sample - GitHub REST API
GET/advisories

List global security advisories

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see "About the GitHub Advisory database."

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

18 parameters
ghsa_idstringoptional
If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.
typestringoptional
If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.
Allowed:reviewedmalwareunreviewedDefault:reviewed
cve_idstringoptional
If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.
ecosystemstringoptional
If specified, only advisories for these ecosystems will be returned.
Allowed:rubygemsnpmpipmavennugetcomposergorusterlangactionspubother
severitystringoptional
If specified, only advisories with these severities will be returned.
Allowed:unknownlowmediumhighcritical
cwesstringoptional
If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`
is_withdrawnbooleanoptional
Whether to only return advisories that have been withdrawn.
affectsstringoptional
If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`
publishedstringoptional
If specified, only return advisories that were published on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
updatedstringoptional
If specified, only return advisories that were updated on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
modifiedstringoptional
If specified, only show advisories that were updated or published on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
epss_percentagestringoptional
If specified, only return advisories that have an EPSS percentage score that matches the provided value. The EPSS percentage represents the likelihood of a CVE being exploited.
epss_percentilestringoptional
If specified, only return advisories that have an EPSS percentile score that matches the provided value. The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
beforestringoptional
A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
afterstringoptional
A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
directionstringoptional
The direction to sort the results by.
Allowed:ascdescDefault:desc
per_pageintegeroptional
The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:30
sortstringoptional
The property to sort the results by.
Allowed:updatedpublishedepss_percentageepss_percentileDefault:published

3 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.
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<string>optional
429Too many requests
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 422 is returned: Validation failed, or the endpoint has been spammed. A 429 is returned: Too many requests.