View Source GitHub.SecurityAdvisories (GitHub REST API Client v0.2.2)
Provides API endpoints related to security advisories
Link to this section Summary
Functions
Privately report a security vulnerability
Create a repository security advisory
Request a CVE for a repository security advisory
Get a global security advisory
Get a repository security advisory
List global security advisories
List repository security advisories for an organization
List repository security advisories
Update a repository security advisory
Link to this section Functions
create_private_vulnerability_report(owner, repo, body, opts \\ [])
View Source@spec create_private_vulnerability_report( String.t(), String.t(), GitHub.PrivateVulnerabilityReport.Create.t(), keyword() ) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Privately report a security vulnerability
Report a security vulnerability to the maintainers of the repository. See "Privately reporting a security vulnerability" for more information about private vulnerability reporting.
resources
Resources
@spec create_repository_advisory( String.t(), String.t(), GitHub.Repository.Advisory.Create.t(), keyword() ) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Create a repository security advisory
Creates a new repository security advisory.
You must authenticate using an access token with the repo
scope or repository_advisories:write
permission to use this endpoint.
In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.
resources
Resources
create_repository_advisory_cve_request(owner, repo, ghsa_id, opts \\ [])
View Source@spec create_repository_advisory_cve_request( String.t(), String.t(), String.t(), keyword() ) :: {:ok, map()} | {:error, GitHub.Error.t()}
Request a CVE for a repository security advisory
If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "Requesting a CVE identification number."
You may request a CVE for public repositories, but cannot do so for private repositories.
You must authenticate using an access token with the repo
scope or repository_advisories:write
permission to use this endpoint.
In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.
resources
Resources
@spec get_global_advisory( String.t(), keyword() ) :: {:ok, GitHub.GlobalAdvisory.t()} | {:error, GitHub.Error.t()}
Get a global security advisory
Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
resources
Resources
@spec get_repository_advisory(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Get a repository security advisory
Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
You can access any published security advisory on a public repository.
You must authenticate using an access token with the repo
scope or repository_advisories:read
permission
in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.
You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on the security advisory.
resources
Resources
@spec list_global_advisories(keyword()) :: {:ok, [GitHub.GlobalAdvisory.t()]} | {:error, GitHub.Error.t()}
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."
options
Options
ghsa_id
: If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.type
: 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_id
: If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.ecosystem
: If specified, only advisories for these ecosystems will be returned.severity
: If specified, only advisories with these severities will be returned.cwes
: If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.Example:
cwes=79,284,22
orcwes[]=79&cwes[]=284&cwes[]=22
is_withdrawn
: Whether to only return advisories that have been withdrawn.affects
: If specified, only return advisories that affect any ofpackage
orpackage@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
oraffects[]=package1&affects[]=package2@1.0.0
published
: 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."
updated
: 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."
modified
: 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."
before
: A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.after
: A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.direction
: The direction to sort the results by.per_page
: The number of results per page (max 100).sort
: The property to sort the results by.
resources
Resources
@spec list_org_repository_advisories( String.t(), keyword() ) :: {:ok, [GitHub.Repository.Advisory.t()]} | {:error, GitHub.Error.t()}
List repository security advisories for an organization
Lists repository security advisories for an organization.
To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo
scope or repository_advisories:write
permission.
options
Options
direction
: The direction to sort the results by.sort
: The property to sort the results by.before
: A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.after
: A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.per_page
: The number of advisories to return per page.state
: Filter by the state of the repository advisories. Only advisories of this state will be returned.
resources
Resources
@spec list_repository_advisories(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Repository.Advisory.t()]} | {:error, GitHub.Error.t()}
List repository security advisories
Lists security advisories in a repository.
You must authenticate using an access token with the repo
scope or repository_advisories:read
permission
in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.
You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.
options
Options
direction
: The direction to sort the results by.sort
: The property to sort the results by.before
: A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.after
: A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.per_page
: Number of advisories to return per page.state
: Filter by state of the repository advisories. Only advisories of this state will be returned.
resources
Resources
update_repository_advisory(owner, repo, ghsa_id, body, opts \\ [])
View Source@spec update_repository_advisory( String.t(), String.t(), String.t(), GitHub.Repository.Advisory.Update.t(), keyword() ) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Update a repository security advisory
Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
You must authenticate using an access token with the repo
scope or repository_advisories:write
permission to use this endpoint.
In order to update any security advisory, you must be a security manager or administrator of that repository, or a collaborator on the repository security advisory.