Interface GitHubAdvisory

Represents a global advisory from the GitHub Advisory Database.

See

https://docs.github.com/en/rest/security-advisories/global-advisories#get-a-global-security-advisory

interface GitHubAdvisory {
    credits: null | { type: string; user: GitHubUser }[];
    cve_id: null | string;
    cvss: null | { score: number; vector_string: string };
    cwes: null | { cwe_id: string; name: string }[];
    description: string;
    ghsa_id: string;
    html_url: string;
    identifiers: { type: string; value: string }[];
    published_at: string;
    references: string[];
    severity: "critical" | "high" | "medium" | "low" | "unknown";
    source_code_location: null | string;
    summary: string;
    type: string;
    updated_at: string;
    url: string;
    vulnerabilities: GitHubAdvisoryVulnerability[];
    withdrawn_at: null | string;
}

Properties

credits cve_id cvss cwes description ghsa_id html_url identifiers published_at references severity source_code_location summary type updated_at url vulnerabilities withdrawn_at

Properties

credits

credits: null | { type: string; user: GitHubUser }[]

Credits for discovering/reporting

cve_id

cve_id: null | string

CVE identifier, if assigned

cvss

cvss: null | { score: number; vector_string: string }

CVSS score and vector string

cwes

cwes: null | { cwe_id: string; name: string }[]

CWE classifications

description

description: string

Full description

ghsa_id

ghsa_id: string

GitHub Security Advisory ID (e.g., 'GHSA-xxxx-xxxx-xxxx')

html_url

html_url: string

URL to the advisory on GitHub

identifiers

identifiers: { type: string; value: string }[]

External identifiers (CVE, GHSA, etc.)

published_at

published_at: string

ISO 8601 publication timestamp

references

references: string[]

External reference URLs

severity

severity: "critical" | "high" | "medium" | "low" | "unknown"

Overall severity

source_code_location

source_code_location: null | string

URL to source code related to the advisory

summary

summary: string

Short summary

type

type: string

Advisory type

updated_at

updated_at: string

ISO 8601 last-updated timestamp

url

url: string

API URL

vulnerabilities

vulnerabilities: GitHubAdvisoryVulnerability[]

Affected packages and version ranges

withdrawn_at

withdrawn_at: null | string

ISO 8601 withdrawal timestamp, or null if still active

Settings

Member Visibility

On This Page

Properties