provider security-advisories POST /repos/{owner}/{repo}/security-advisories
@utdk/github /repos/{owner}/{repo}/security-advisories
Create a repository security 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.
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

securityAdvisories.createRepositoryAdvisory
POST/repos/{owner}/{repo}/security-advisories
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.

Parameters

required

The account owner of the repository. The name is not case sensitive.

required

The name of the repository without the `.git` extension. The name is not case sensitive.

Input

required

A short summary of the advisory.

required

A detailed description of what the advisory impacts.

The Common Vulnerabilities and Exposures (CVE) ID.

required

A product affected by the vulnerability detailed in a repository security advisory.

A list of Common Weakness Enumeration (CWE) IDs.

A list of users receiving credit for their participation in the security advisory.

The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.

The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.

Whether to create a temporary private fork of the repository to collaborate on a fix.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.securityAdvisories.createRepositoryAdvisory({
  "start_private_fork": false
})