global_advisories

Overview

Name	`global_advisories`
Type	Resource
Id	`github.security_advisories.global_advisories`

Name	Datatype	Description
`description`	`string`	A detailed description of what the advisory entails.
`credits`	`array`	The users who contributed to the advisory.
`cve_id`	`string`	The Common Vulnerabilities and Exposures (CVE) ID.
`cvss`	`object`
`cwes`	`array`
`ghsa_id`	`string`	The GitHub Security Advisory ID.
`github_reviewed_at`	`string`	The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
`html_url`	`string`	The URL for the advisory.
`identifiers`	`array`
`nvd_published_at`	`string`	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.
`published_at`	`string`	The date and time of when the advisory was published, in ISO 8601 format.
`references`	`array`
`repository_advisory_url`	`string`	The API URL for the repository advisory.
`severity`	`string`	The severity of the advisory.
`source_code_location`	`string`	The URL of the advisory's source code.
`summary`	`string`	A short summary of the advisory.
`type`	`string`	The type of advisory.
`updated_at`	`string`	The date and time of when the advisory was last updated, in ISO 8601 format.
`url`	`string`	The API URL for the advisory.
`vulnerabilities`	`array`	The products and respective version ranges affected by the advisory.
`withdrawn_at`	`string`	The date and time of when the advisory was withdrawn, in ISO 8601 format.

Name	Accessible by	Required Params	Description
`get_global_advisory`	`SELECT`	`ghsa_id`	Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
`list_global_advisories`	`SELECT`		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."