Module security_advisories_api

Source

Enums§

SecurityAdvisoriesSlashCreateForkError
struct for typed errors of method security_advisories_slash_create_fork
SecurityAdvisoriesSlashCreatePrivateVulnerabilityReportError
struct for typed errors of method security_advisories_slash_create_private_vulnerability_report
SecurityAdvisoriesSlashCreateRepositoryAdvisoryCveRequestError
struct for typed errors of method security_advisories_slash_create_repository_advisory_cve_request
SecurityAdvisoriesSlashCreateRepositoryAdvisoryError
struct for typed errors of method security_advisories_slash_create_repository_advisory
SecurityAdvisoriesSlashGetGlobalAdvisoryError
struct for typed errors of method security_advisories_slash_get_global_advisory
SecurityAdvisoriesSlashGetRepositoryAdvisoryError
struct for typed errors of method security_advisories_slash_get_repository_advisory
SecurityAdvisoriesSlashListGlobalAdvisoriesError
struct for typed errors of method security_advisories_slash_list_global_advisories
SecurityAdvisoriesSlashListOrgRepositoryAdvisoriesError
struct for typed errors of method security_advisories_slash_list_org_repository_advisories
SecurityAdvisoriesSlashListRepositoryAdvisoriesError
struct for typed errors of method security_advisories_slash_list_repository_advisories
SecurityAdvisoriesSlashUpdateRepositoryAdvisoryError
struct for typed errors of method security_advisories_slash_update_repository_advisory

Functions§

security_advisories_slash_create_fork
Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. Note: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
security_advisories_slash_create_private_vulnerability_report
Report a security vulnerability to the maintainers of the repository. See "Privately reporting a security vulnerability" for more information about private vulnerability reporting.
security_advisories_slash_create_repository_advisory
Creates a new repository security advisory. In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. OAuth app tokens and personal access tokens (classic) need the repo or repository_advisories:write scope to use this endpoint.
security_advisories_slash_create_repository_advisory_cve_request
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. In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. OAuth app tokens and personal access tokens (classic) need the repo or repository_advisories:write scope to use this endpoint.
security_advisories_slash_get_global_advisory
Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
security_advisories_slash_get_repository_advisory
Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. Anyone can access any published security advisory on a public repository. The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on the security advisory. OAuth app tokens and personal access tokens (classic) need the repo or repository_advisories:read scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
security_advisories_slash_list_global_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."
security_advisories_slash_list_org_repository_advisories
Lists repository security advisories for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the repo or repository_advisories:write scope to use this endpoint.
security_advisories_slash_list_repository_advisories
Lists security advisories in a repository. The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. OAuth app tokens and personal access tokens (classic) need the repo or repository_advisories:read scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
security_advisories_slash_update_repository_advisory
Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, or a collaborator on the repository security advisory. OAuth app tokens and personal access tokens (classic) need the repo or repository_advisories:write scope to use this endpoint.