Interface AdvisoriesParams

Query parameters for listing global advisories.

See

https://docs.github.com/en/rest/security-advisories/global-advisories#list-global-security-advisories

interface AdvisoriesParams {
    cve_id?: string;
    cwe_id?: string;
    direction?: "asc" | "desc";
    ecosystem?: string;
    ghsa_id?: string;
    is_withdrawn?: boolean;
    page?: number;
    per_page?: number;
    severity?: "critical" | "high" | "medium" | "low" | "unknown";
    sort?: "updated" | "published";
}

Hierarchy (View Summary)

Properties

cve_id? cwe_id? direction? ecosystem? ghsa_id? is_withdrawn? page? per_page? severity? sort?

Properties

Optionalcve_id

cve_id?: string

Filter by CVE ID

Optionalcwe_id

cwe_id?: string

Filter by CWE ID

Optionaldirection

direction?: "asc" | "desc"

Sort direction

Optionalecosystem

ecosystem?: string

Filter by ecosystem (e.g., 'npm', 'pip')

Optionalghsa_id

ghsa_id?: string

Filter by GHSA ID

Optionalis_withdrawn

is_withdrawn?: boolean

Whether to include withdrawn advisories

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

Optionalseverity

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

Filter by severity

Optionalsort

sort?: "updated" | "published"

Sort field

Settings

Member Visibility

On This Page

Properties