v68

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.3 MB

security-advisories

Get a global security advisory

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

get/advisories/{ghsa_id}

Path parameters

ghsa_idstring required

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

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"
      }
    }
  ]
}