Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
security-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."

get/advisories

Query parameters

ghsa_idstring

If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.

type'reviewed' | 'malware' | 'unreviewed'

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.

cve_idstring

If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.

ecosystem'rubygems' | 'npm' | 'pip' | 'maven' | 'nuget' | 'composer' | 'go' | 'rust' | 'erlang' | 'actions' | 'pub' | 'other' | 'swift'

The package's language or package management ecosystem.

If specified, only advisories for these ecosystems will be returned.

severity'unknown' | 'low' | 'medium' | 'high' | 'critical'

If specified, only advisories with these severities will be returned.

string
OR
string[]

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_withdrawnboolean

Whether to only return advisories that have been withdrawn.

string
OR
string[]

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

publishedstring

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."

updatedstring

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."

modifiedstring

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."

epss_percentagestring

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_percentilestring

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.

beforestring

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."

afterstring

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

direction'asc' | 'desc'

The direction to sort the results by.

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

sort'updated' | 'published' | 'epss_percentage' | 'epss_percentile'

The property to sort the results by.

Response

Response

ghsa_idstring required

The GitHub Security Advisory ID.

cve_idstring nullable required

The Common Vulnerabilities and Exposures (CVE) ID.

urlstring required

The API URL for the advisory.

html_urlstring uri required

The URL for the advisory.

repository_advisory_urlstring uri nullable required

The API URL for the repository advisory.

summarystring required

A short summary of the advisory.

descriptionstring nullable required

A detailed description of what the advisory entails.

type'reviewed' | 'unreviewed' | 'malware' required

The type of advisory.

severity'critical' | 'high' | 'medium' | 'low' | 'unknown' required

The severity of the advisory.

source_code_locationstring uri nullable required

The URL of the advisory's source code.

referencesstring[] nullable required
published_atstring date-time required

The date and time of when the advisory was published, in ISO 8601 format.

updated_atstring date-time required

The date and time of when the advisory was last updated, in ISO 8601 format.

github_reviewed_atstring date-time nullable required

The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.

nvd_published_atstring date-time nullable required

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_atstring date-time nullable required

The date and time of when the advisory was withdrawn, in ISO 8601 format.

Example response

[
  {
    "credits": [
      {
        "user": {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        }
      }
    ]
  }
]