POST

Try POST /repos/{owner}/{repo}/security-advisories/reports — GitHub API

GitHub playground

Privately report a security vulnerability

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive.

Body application/json

7 body fields

summary · required · string — A short summary of the advisory.
description · required · string — A detailed description of what the advisory impacts.
vulnerabilities · optional · object[] — An array of products affected by the vulnerability detailed in a repository security advisory.
cwe_ids · optional · string[] — A list of Common Weakness Enumeration (CWE) IDs.
severity · optional · string — The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
cvss_vector_string · optional · string — The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.
start_private_fork · optional · boolean — Whether to create a temporary private fork of the repository to collaborate on a fix. The fork is created only if you are permitted to create one; otherwise, this parameter is ignored and the report is still created.