Skip to content
forgit api docs

Update a repository security advisory

PATCH
/repos/{owner}/{repo}/security-advisories/{ghsa_id}

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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
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.

ghsa_id
required
string

The GHSA (GitHub Security Advisory) identifier of the advisory.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
summary

A short summary of the advisory.

string
<= 1024 characters
description

A detailed description of what the advisory impacts.

string
<= 65535 characters
cve_id

The Common Vulnerabilities and Exposures (CVE) ID.

string
nullable
vulnerabilities

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

Array<object>
object
package
required

The name of the package affected by the vulnerability.

object
ecosystem
required

The package’s language or package management ecosystem.

string
Allowed values: rubygems npm pip maven nuget composer go rust erlang actions pub other swift
name

The unique package name within its ecosystem.

string
nullable
vulnerable_version_range

The range of the package versions affected by the vulnerability.

string
nullable
patched_versions

The package version(s) that resolve the vulnerability.

string
nullable
vulnerable_functions

The functions in the package that are affected.

Array<string>
nullable
cwe_ids

A list of Common Weakness Enumeration (CWE) IDs.

Array<string>
nullable
credits

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

Array<object>
nullable
object
login
required

The username of the user credited.

string
type
required

The type of credit the user is receiving.

string
Allowed values: analyst finder reporter coordinator remediation_developer remediation_reviewer remediation_verifier tool sponsor other
severity

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

string
nullable
Allowed values: critical high medium low
cvss_vector_string

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

string
nullable
state

The state of the advisory.

string
Allowed values: published closed draft
collaborating_users

A list of usernames who have been granted write access to the advisory.

Array<string>
nullable
collaborating_teams

A list of team slugs which have been granted write access to the advisory.

Array<string>
nullable
Examples

Updating the severity and state. 

{
  "severity": "critical",
  "state": "published"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json

A repository security advisory.

object
ghsa_id
required

The GitHub Security Advisory ID.

string
cve_id
required

The Common Vulnerabilities and Exposures (CVE) ID.

string
nullable
url
required

The API URL for the advisory.

string format: uri
html_url
required

The URL for the advisory.

string format: uri
summary
required

A short summary of the advisory.

string
<= 1024 characters
description
required

A detailed description of what the advisory entails.

string
nullable <= 65535 characters
severity
required

The severity of the advisory.

string
nullable
Allowed values: critical high medium low
author
required

The author of the advisory.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
publisher
required

The publisher of the advisory.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
identifiers
required
Array<object>
object
type
required

The type of identifier.

string
Allowed values: CVE GHSA
value
required

The identifier value.

string
state
required

The state of the advisory.

string
Allowed values: published closed withdrawn draft triage
created_at
required

The date and time of when the advisory was created, in ISO 8601 format.

string format: date-time
nullable
updated_at
required

The date and time of when the advisory was last updated, in ISO 8601 format.

string format: date-time
nullable
published_at
required

The date and time of when the advisory was published, in ISO 8601 format.

string format: date-time
nullable
closed_at
required

The date and time of when the advisory was closed, in ISO 8601 format.

string format: date-time
nullable
withdrawn_at
required

The date and time of when the advisory was withdrawn, in ISO 8601 format.

string format: date-time
nullable
submission
required
object
accepted
required

Whether a private vulnerability report was accepted by the repository’s administrators.

boolean
vulnerabilities
required
Array<object>
nullable

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

object
package
required

The name of the package affected by the vulnerability.

object
ecosystem
required

The package’s language or package management ecosystem.

string
Allowed values: rubygems npm pip maven nuget composer go rust erlang actions pub other swift
name
required

The unique package name within its ecosystem.

string
nullable
vulnerable_version_range
required

The range of the package versions affected by the vulnerability.

string
nullable
patched_versions
required

The package version(s) that resolve the vulnerability.

string
nullable
vulnerable_functions
required

The functions in the package that are affected.

Array<string>
nullable
cvss
required
object
vector_string
required

The CVSS vector.

string
nullable
score
required

The CVSS score.

number
nullable <= 10
cvss_severities
object
cvss_v3
object
vector_string
required

The CVSS 3 vector string.

string
nullable
score
required

The CVSS 3 score.

number
nullable <= 10
cvss_v4
object
vector_string
required

The CVSS 4 vector string.

string
nullable
score
required

The CVSS 4 score.

number
nullable <= 10
cwes
required
Array<object>
nullable
object
cwe_id
required

The Common Weakness Enumeration (CWE) identifier.

string
name
required

The name of the CWE.

string
cwe_ids
required

A list of only the CWE IDs.

Array<string>
nullable
credits
required
Array<object>
nullable
object
login

The username of the user credited.

string
type

The type of credit the user is receiving.

string
Allowed values: analyst finder reporter coordinator remediation_developer remediation_reviewer remediation_verifier tool sponsor other
credits_detailed
required
Array<object>
nullable

A credit given to a user for a repository security advisory.

object
user
required
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
type
required

The type of credit the user is receiving.

string
Allowed values: analyst finder reporter coordinator remediation_developer remediation_reviewer remediation_verifier tool sponsor other
state
required

The state of the user’s acceptance of the credit.

string
Allowed values: accepted declined pending
collaborating_users
required

A list of users that collaborate on the advisory.

Array<object>
nullable
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
collaborating_teams
required

A list of teams that collaborate on the advisory.

Array<object>
nullable
Team

Groups of organization members that gives permissions on specified repositories.

object
id
required
integer
node_id
required
string
name
required
string
slug
required
string
description
required
string
nullable
privacy
string
notification_setting
string
permission
required
string
permissions
object
pull
required
boolean
triage
required
boolean
push
required
boolean
maintain
required
boolean
admin
required
boolean
url
required
string format: uri
html_url
required
string format: uri
members_url
required
string
repositories_url
required
string format: uri
type
required

The ownership type of the team

string
Allowed values: enterprise organization
access_source

How the team’s access to the repository was granted. This property is only present when the team is returned in a repository context, such as GET /repos/{owner}/{repo}/teams.

string
Allowed values: direct organization enterprise
organization_id

Unique identifier of the organization to which this team belongs

integer
enterprise_id

Unique identifier of the enterprise to which this team belongs

integer
parent
required
Team Simple

Groups of organization members that gives permissions on specified repositories.

object
id
required

Unique identifier of the team

integer
node_id
required
string
url
required

URL for the team

string format: uri
members_url
required
string
name
required

Name of the team

string
description
required

Description of the team

string
nullable
permission
required

Permission that the team will have for its repositories

string
privacy

The level of privacy this team should have

string
notification_setting

The notification setting the team has set

string
html_url
required
string format: uri
repositories_url
required
string format: uri
slug
required
string
ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string
type
required

The ownership type of the team

string
Allowed values: enterprise organization
organization_id

Unique identifier of the organization to which this team belongs

integer
enterprise_id

Unique identifier of the enterprise to which this team belongs

integer
private_fork
required

A temporary private fork of the advisory’s repository for collaborating on a fix.

object
id
required

A unique identifier of the repository.

integer format: int64
node_id
required

The GraphQL identifier of the repository.

string
name
required

The name of the repository.

string
full_name
required

The full, globally unique, name of the repository.

string
owner
required
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
private
required

Whether the repository is private.

boolean
html_url
required

The URL to view the repository on GitHub.com.

string format: uri
description
required

The repository description.

string
nullable
fork
required

Whether the repository is a fork.

boolean
url
required

The URL to get more information about the repository from the GitHub API.

string format: uri
archive_url
required

A template for the API URL to download the repository as an archive.

string
assignees_url
required

A template for the API URL to list the available assignees for issues in the repository.

string
blobs_url
required

A template for the API URL to create or retrieve a raw Git blob in the repository.

string
branches_url
required

A template for the API URL to get information about branches in the repository.

string
collaborators_url
required

A template for the API URL to get information about collaborators of the repository.

string
comments_url
required

A template for the API URL to get information about comments on the repository.

string
commits_url
required

A template for the API URL to get information about commits on the repository.

string
compare_url
required

A template for the API URL to compare two commits or refs.

string
contents_url
required

A template for the API URL to get the contents of the repository.

string
contributors_url
required

A template for the API URL to list the contributors to the repository.

string format: uri
deployments_url
required

The API URL to list the deployments of the repository.

string format: uri
downloads_url
required

The API URL to list the downloads on the repository.

string format: uri
events_url
required

The API URL to list the events of the repository.

string format: uri
forks_url
required

The API URL to list the forks of the repository.

string format: uri
git_commits_url
required

A template for the API URL to get information about Git commits of the repository.

string
git_refs_url
required

A template for the API URL to get information about Git refs of the repository.

string
git_tags_url
required

A template for the API URL to get information about Git tags of the repository.

string
issue_comment_url
required

A template for the API URL to get information about issue comments on the repository.

string
issue_events_url
required

A template for the API URL to get information about issue events on the repository.

string
issues_url
required

A template for the API URL to get information about issues on the repository.

string
keys_url
required

A template for the API URL to get information about deploy keys on the repository.

string
labels_url
required

A template for the API URL to get information about labels of the repository.

string
languages_url
required

The API URL to get information about the languages of the repository.

string format: uri
merges_url
required

The API URL to merge branches in the repository.

string format: uri
milestones_url
required

A template for the API URL to get information about milestones of the repository.

string
notifications_url
required

A template for the API URL to get information about notifications on the repository.

string
pulls_url
required

A template for the API URL to get information about pull requests on the repository.

string
releases_url
required

A template for the API URL to get information about releases on the repository.

string
stargazers_url
required

The API URL to list the stargazers on the repository.

string format: uri
statuses_url
required

A template for the API URL to get information about statuses of a commit.

string
subscribers_url
required

The API URL to list the subscribers on the repository.

string format: uri
subscription_url
required

The API URL to subscribe to notifications for this repository.

string format: uri
tags_url
required

The API URL to get information about tags on the repository.

string format: uri
teams_url
required

The API URL to list the teams on the repository.

string format: uri
trees_url
required

A template for the API URL to create or retrieve a raw Git tree of the repository.

string
hooks_url
required

The API URL to list the hooks on the repository.

string format: uri
Examples
{
  "ghsa_id": "GHSA-abcd-1234-efgh",
  "cve_id": "CVE-2050-00000",
  "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
  "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
  "summary": "A short summary of the advisory.",
  "description": "A detailed description of what the advisory entails.",
  "severity": "critical",
  "author": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "publisher": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "identifiers": [
    {
      "type": "GHSA",
      "value": "GHSA-abcd-1234-efgh"
    },
    {
      "type": "CVE",
      "value": "CVE-2050-00000"
    }
  ],
  "state": "published",
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-02T00:00:00Z",
  "published_at": "2020-01-03T00:00:00Z",
  "closed_at": null,
  "withdrawn_at": null,
  "submission": null,
  "vulnerabilities": [
    {
      "package": {
        "ecosystem": "pip",
        "name": "a-package"
      },
      "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
      "patched_versions": "1.0.1",
      "vulnerable_functions": [
        "function1"
      ]
    },
    {
      "package": {
        "ecosystem": "pip",
        "name": "another-package"
      },
      "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
      "patched_versions": "1.0.2",
      "vulnerable_functions": [
        "function2"
      ]
    }
  ],
  "cvss": {
    "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
    "score": 9.8
  },
  "cvss_severities": {
    "cvss_v3": {
      "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
      "score": 9.8
    },
    "cvss_v4": {
      "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N",
      "score": 9.3
    }
  },
  "cwes": [
    {
      "cwe_id": "CWE-123",
      "name": "A CWE"
    }
  ],
  "cwe_ids": [
    "CWE-123"
  ],
  "credits": [
    {
      "login": "octocat",
      "type": "analyst"
    }
  ],
  "credits_detailed": [
    {
      "user": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "type": "analyst",
      "state": "accepted"
    }
  ],
  "collaborating_users": [
    {
      "login": "octokitten",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octokitten",
      "html_url": "https://github.com/octokitten",
      "followers_url": "https://api.github.com/users/octokitten/followers",
      "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
      "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
      "organizations_url": "https://api.github.com/users/octokitten/orgs",
      "repos_url": "https://api.github.com/users/octokitten/repos",
      "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octokitten/received_events",
      "type": "User",
      "site_admin": false
    }
  ],
  "collaborating_teams": [
    {
      "name": "Justice League",
      "id": 1,
      "node_id": "MDQ6VGVhbTE=",
      "slug": "justice-league",
      "description": "A great team.",
      "privacy": "closed",
      "notification_setting": "notifications_enabled",
      "url": "https://api.github.com/teams/1",
      "html_url": "https://github.com/orgs/github/teams/justice-league",
      "members_url": "https://api.github.com/teams/1/members{/member}",
      "repositories_url": "https://api.github.com/teams/1/repos",
      "permission": "admin",
      "parent": null
    }
  ],
  "private_fork": {
    "id": 217723378,
    "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
    "name": "octo-repo-ghsa-abcd-1234-efgh",
    "full_name": "octo-org/octo-repo-ghsa-abcd-1234-efgh",
    "owner": {
      "login": "octo-org",
      "id": 6811672,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octo-org",
      "html_url": "https://github.com/octo-org",
      "followers_url": "https://api.github.com/users/octo-org/followers",
      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
      "organizations_url": "https://api.github.com/users/octo-org/orgs",
      "repos_url": "https://api.github.com/users/octo-org/repos",
      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octo-org/received_events",
      "type": "Organization",
      "site_admin": false
    },
    "private": true,
    "html_url": "https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh",
    "description": null,
    "fork": false,
    "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh",
    "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref}",
    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user}",
    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha}",
    "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch}",
    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator}",
    "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number}",
    "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha}",
    "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head}",
    "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path}",
    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors",
    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments",
    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads",
    "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events",
    "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks",
    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha}",
    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha}",
    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha}",
    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks",
    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number}",
    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number}",
    "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number}",
    "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id}",
    "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name}",
    "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages",
    "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges",
    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number}",
    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating}",
    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number}",
    "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id}",
    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers",
    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha}",
    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers",
    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription",
    "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags",
    "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams",
    "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Examples
{
  "message": "Invalid state transition from `published` to `draft`."
}