apicheats.dev github/llms.txt Raw .md
PATCH

PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number} — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Update a code scanning alert

Base URL
https://api.github.com
Auth
Authorization: Bearer <GITHUB_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 390 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X PATCH 'https://api.github.com/repos/example-owner/example-repo/code-scanning/alerts/10' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "state": "open"}'

Parameters

Name In Type Required Description
owner path string Yes The account owner of the repository. The name is not case sensitive.
repo path string Yes The name of the repository without the `.git` extension. The name is not case sensitive.
alert_number path integer Yes The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
state body string Yes Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
dismissed_reason body string No **Required when the state is dismissed.** The reason for dismissing or closing the alert.
dismissed_comment body string No The dismissal comment associated with the dismissal of the alert.
create_request body boolean No If `true`, attempt to create an alert dismissal request.
assignees body string[] No The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.

Response 200 OK

{
  "number": 0,
  "created_at": "2026-09-03T00:00:00Z",
  "updated_at": "2026-09-03T00:00:00Z",
  "url": "https://example.com",
  "html_url": "https://example.com",
  "instances_url": "https://example.com",
  "state": "open",
  "fixed_at": "2026-09-03T00:00:00Z",
  "dismissed_by": {
    "name": "string",
    "email": "string",
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "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": true,
    "starred_at": "\"2020-07-09T00:17:55Z\"",
    "user_view_type": "public"
  },
  "dismissed_at": "2026-09-03T00:00:00Z",
  "dismissed_reason": "false positive",
  "dismissed_comment": "string",
  "rule": {
    "id": "string",
    "name": "string",
    "severity": "none",
    "security_severity_level": "low",
    "description": "string",
    "full_description": "string",
    "tags": [
      "string"
    ],
    "help": "string",
    "help_uri": "string"
  },
  "tool": {
    "name": "string",
    "version": "string",
    "guid": "string"
  },
  "most_recent_instance": {
    "ref": "string",
    "analysis_key": "string",
    "environment": "string",
    "category": "string",
    "state": "open",
    "commit_sha": "string",
    "message": {
      "text": "string",
      "markdown": "string"
    },
    "location": {
      "path": "string",
      "start_line": 0,
      "end_line": 0,
      "start_column": 0,
      "end_column": 0
    },
    "html_url": "string",
    "classifications": [
      "source"
    ]
  },
  "dismissal_approved_by": {
    "name": "string",
    "email": "string",
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "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": true,
    "starred_at": "\"2020-07-09T00:17:55Z\"",
    "user_view_type": "public"
  },
  "assignees": [
    {
      "name": "string",
      "email": "string",
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "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": true,
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "user_view_type": "public"
    }
  ],
  "linked_pull_requests": [
    {
      "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
      "id": 1,
      "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
      "html_url": "https://github.com/octocat/Hello-World/pull/1347",
      "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
      "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
      "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
      "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
      "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
      "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
      "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
      "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
      "number": 1347,
      "state": "open",
      "locked": true,
      "title": "new-feature",
      "user": {
        "name": "string",
        "email": "string",
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
        "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": true,
        "starred_at": "\"2020-07-09T00:17:55Z\"",
        "user_view_type": "public"
      },
      "body": "Please pull these awesome changes",
      "labels": [
        {
          "id": 0,
          "node_id": "string",
          "url": "string",
          "name": "string",
          "description": "string",
          "color": "string",
          "default": true,
          "archived_by": {
            "name": "[recursive or deeply nested schema]",
            "email": "[recursive or deeply nested schema]",
            "login": "[recursive or deeply nested schema]",
            "id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "avatar_url": "[recursive or deeply nested schema]",
            "gravatar_id": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]",
            "followers_url": "[recursive or deeply nested schema]",
            "following_url": "[recursive or deeply nested schema]",
            "gists_url": "[recursive or deeply nested schema]",
            "starred_url": "[recursive or deeply nested schema]",
            "subscriptions_url": "[recursive or deeply nested schema]",
            "organizations_url": "[recursive or deeply nested schema]",
            "repos_url": "[recursive or deeply nested schema]",
            "events_url": "[recursive or deeply nested schema]",
            "received_events_url": "[recursive or deeply nested schema]",
            "type": "[recursive or deeply nested schema]",
            "site_admin": "[recursive or deeply nested schema]",
            "starred_at": "[recursive or deeply nested schema]",
            "user_view_type": "[recursive or deeply nested schema]"
          }
        }
      ],
      "milestone": {
        "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
        "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
        "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
        "id": 1002604,
        "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
        "number": 42,
        "state": "open",
        "title": "v1.0",
        "description": "Tracking milestone for version 1.0",
        "creator": {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "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": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        },
        "open_issues": 4,
        "closed_issues": 8,
        "created_at": "2011-04-10T20:09:31Z",
        "updated_at": "2014-03-03T18:58:10Z",
        "closed_at": "2013-02-12T13:22:01Z",
        "due_on": "2012-10-09T23:39:01Z"
      },
      "active_lock_reason": "too heated",
      "created_at": "2011-01-26T19:01:12Z",
      "updated_at": "2011-01-26T19:01:12Z",
      "closed_at": "2011-01-26T19:01:12Z",
      "merged_at": "2011-01-26T19:01:12Z",
      "assignees": [
        {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "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": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        }
      ],
      "requested_reviewers": [
        {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "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": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        }
      ],
      "requested_teams": [
        {
          "id": 0,
          "node_id": "string",
          "name": "string",
          "slug": "string",
          "description": "string",
          "privacy": "string",
          "notification_setting": "string",
          "permission": "string",
          "permissions": {
            "pull": "[recursive or deeply nested schema]",
            "triage": "[recursive or deeply nested schema]",
            "push": "[recursive or deeply nested schema]",
            "maintain": "[recursive or deeply nested schema]",
            "admin": "[recursive or deeply nested schema]"
          },
          "url": "https://example.com",
          "html_url": "https://github.com/orgs/rails/teams/core",
          "members_url": "string",
          "repositories_url": "https://example.com",
          "type": "enterprise",
          "access_source": "direct",
          "organization_id": 37,
          "enterprise_id": 42,
          "parent": {
            "id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "members_url": "[recursive or deeply nested schema]",
            "name": "[recursive or deeply nested schema]",
            "description": "[recursive or deeply nested schema]",
            "permission": "[recursive or deeply nested schema]",
            "privacy": "[recursive or deeply nested schema]",
            "notification_setting": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]",
            "repositories_url": "[recursive or deeply nested schema]",
            "slug": "[recursive or deeply nested schema]",
            "ldap_dn": "[recursive or deeply nested schema]",
            "type": "[recursive or deeply nested schema]",
            "organization_id": "[recursive or deeply nested schema]",
            "enterprise_id": "[recursive or deeply nested schema]"
          }
        }
      ],
      "head": {
        "label": "string",
        "ref": "string",
        "repo": {
          "id": 42,
          "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
          "name": "Team Environment",
          "full_name": "octocat/Hello-World",
          "license": {
            "key": "[recursive or deeply nested schema]",
            "name": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "spdx_id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]"
          },
          "forks": 0,
          "permissions": {
            "admin": "[recursive or deeply nested schema]",
            "pull": "[recursive or deeply nested schema]",
            "triage": "[recursive or deeply nested schema]",
            "push": "[recursive or deeply nested schema]",
            "maintain": "[recursive or deeply nested schema]"
          },
          "owner": {
            "name": "[recursive or deeply nested schema]",
            "email": "[recursive or deeply nested schema]",
            "login": "[recursive or deeply nested schema]",
            "id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "avatar_url": "[recursive or deeply nested schema]",
            "gravatar_id": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]",
            "followers_url": "[recursive or deeply nested schema]",
            "following_url": "[recursive or deeply nested schema]",
            "gists_url": "[recursive or deeply nested schema]",
            "starred_url": "[recursive or deeply nested schema]",
            "subscriptions_url": "[recursive or deeply nested schema]",
            "organizations_url": "[recursive or deeply nested schema]",
            "repos_url": "[recursive or deeply nested schema]",
            "events_url": "[recursive or deeply nested schema]",
            "received_events_url": "[recursive or deeply nested schema]",
            "type": "[recursive or deeply nested schema]",
            "site_admin": "[recursive or deeply nested schema]",
            "starred_at": "[recursive or deeply nested schema]",
            "user_view_type": "[recursive or deeply nested schema]"
          },
          "private": false,
          "html_url": "https://github.com/octocat/Hello-World",
          "description": "This your first repo!",
          "fork": true,
          "url": "https://api.github.com/repos/octocat/Hello-World",
          "archive_url": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
          "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
          "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
          "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
          "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
          "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
          "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
          "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
          "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
          "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
          "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
          "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
          "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
          "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
          "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
          "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
          "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
          "git_url": "git:github.com/octocat/Hello-World.git",
          "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
          "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
          "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
          "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
          "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
          "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
          "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
          "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
          "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
          "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
          "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
          "ssh_url": "[email protected]:octocat/Hello-World.git",
          "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
          "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
          "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
          "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
          "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
          "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
          "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
          "clone_url": "https://github.com/octocat/Hello-World.git",
          "mirror_url": "git:git.example.com/octocat/Hello-World",
          "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
          "svn_url": "https://svn.github.com/octocat/Hello-World",
          "homepage": "https://github.com",
          "language": "string",
          "forks_count": 9,
          "stargazers_count": 80,
          "watchers_count": 80,
          "size": 108,
          "default_branch": "master",
          "open_issues_count": 0,
          "is_template": true,
          "topics": [
            "[recursive or deeply nested schema]"
          ],
          "has_issues": true,
          "has_projects": true,
          "has_wiki": true,
          "has_pages": true,
          "has_discussions": true,
          "has_pull_requests": true,
          "pull_request_creation_policy": "all",
          "archived": false,
          "disabled": true,
          "visibility": "public",
          "pushed_at": "2011-01-26T19:06:43Z",
          "created_at": "2011-01-26T19:01:12Z",
          "updated_at": "2011-01-26T19:14:43Z",
          "allow_rebase_merge": true,
          "temp_clone_token": "string",
          "allow_squash_merge": true,
          "allow_auto_merge": false,
          "delete_branch_on_merge": false,
          "allow_update_branch": false,
          "squash_merge_commit_title": "PR_TITLE",
          "squash_merge_commit_message": "PR_BODY",
          "merge_commit_title": "PR_TITLE",
          "merge_commit_message": "PR_BODY",
          "allow_merge_commit": true,
          "allow_forking": true,
          "web_commit_signoff_required": false,
          "open_issues": 0,
          "watchers": 0,
          "starred_at": "\"2020-07-09T00:17:42Z\"",
          "anonymous_access_enabled": true,
          "code_search_index_status": {
            "lexical_search_ok": "[recursive or deeply nested schema]",
            "lexical_commit_sha": "[recursive or deeply nested schema]"
          }
        },
        "sha": "string",
        "user": {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "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": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        }
      },
      "base": {
        "label": "string",
        "ref": "string",
        "repo": {
          "id": 42,
          "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
          "name": "Team Environment",
          "full_name": "octocat/Hello-World",
          "license": {
            "key": "[recursive or deeply nested schema]",
            "name": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "spdx_id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]"
          },
          "forks": 0,
          "permissions": {
            "admin": "[recursive or deeply nested schema]",
            "pull": "[recursive or deeply nested schema]",
            "triage": "[recursive or deeply nested schema]",
            "push": "[recursive or deeply nested schema]",
            "maintain": "[recursive or deeply nested schema]"
          },
          "owner": {
            "name": "[recursive or deeply nested schema]",
            "email": "[recursive or deeply nested schema]",
            "login": "[recursive or deeply nested schema]",
            "id": "[recursive or deeply nested schema]",
            "node_id": "[recursive or deeply nested schema]",
            "avatar_url": "[recursive or deeply nested schema]",
            "gravatar_id": "[recursive or deeply nested schema]",
            "url": "[recursive or deeply nested schema]",
            "html_url": "[recursive or deeply nested schema]",
            "followers_url": "[recursive or deeply nested schema]",
            "following_url": "[recursive or deeply nested schema]",
            "gists_url": "[recursive or deeply nested schema]",
            "starred_url": "[recursive or deeply nested schema]",
            "subscriptions_url": "[recursive or deeply nested schema]",
            "organizations_url": "[recursive or deeply nested schema]",
            "repos_url": "[recursive or deeply nested schema]",
            "events_url": "[recursive or deeply nested schema]",
            "received_events_url": "[recursive or deeply nested schema]",
            "type": "[recursive or deeply nested schema]",
            "site_admin": "[recursive or deeply nested schema]",
            "starred_at": "[recursive or deeply nested schema]",
            "user_view_type": "[recursive or deeply nested schema]"
          },
          "private": false,
          "html_url": "https://github.com/octocat/Hello-World",
          "description": "This your first repo!",
          "fork": true,
          "url": "https://api.github.com/repos/octocat/Hello-World",
          "archive_url": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
          "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
          "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
          "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
          "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
          "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
          "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
          "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
          "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
          "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
          "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
          "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
          "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
          "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
          "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
          "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
          "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
          "git_url": "git:github.com/octocat/Hello-World.git",
          "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
          "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
          "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
          "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
          "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
          "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
          "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
          "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
          "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
          "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
          "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
          "ssh_url": "[email protected]:octocat/Hello-World.git",
          "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
          "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
          "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
          "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
          "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
          "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
          "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
          "clone_url": "https://github.com/octocat/Hello-World.git",
          "mirror_url": "git:git.example.com/octocat/Hello-World",
          "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
          "svn_url": "https://svn.github.com/octocat/Hello-World",
          "homepage": "https://github.com",
          "language": "string",
          "forks_count": 9,
          "stargazers_count": 80,
          "watchers_count": 80,
          "size": 108,
          "default_branch": "master",
          "open_issues_count": 0,
          "is_template": true,
          "topics": [
            "[recursive or deeply nested schema]"
          ],
          "has_issues": true,
          "has_projects": true,
          "has_wiki": true,
          "has_pages": true,
          "has_discussions": true,
          "has_pull_requests": true,
          "pull_request_creation_policy": "all",
          "archived": false,
          "disabled": true,
          "visibility": "public",
          "pushed_at": "2011-01-26T19:06:43Z",
          "created_at": "2011-01-26T19:01:12Z",
          "updated_at": "2011-01-26T19:14:43Z",
          "allow_rebase_merge": true,
          "temp_clone_token": "string",
          "allow_squash_merge": true,
          "allow_auto_merge": false,
          "delete_branch_on_merge": false,
          "allow_update_branch": false,
          "squash_merge_commit_title": "PR_TITLE",
          "squash_merge_commit_message": "PR_BODY",
          "merge_commit_title": "PR_TITLE",
          "merge_commit_message": "PR_BODY",
          "allow_merge_commit": true,
          "allow_forking": true,
          "web_commit_signoff_required": false,
          "open_issues": 0,
          "watchers": 0,
          "starred_at": "\"2020-07-09T00:17:42Z\"",
          "anonymous_access_enabled": true,
          "code_search_index_status": {
            "lexical_search_ok": "[recursive or deeply nested schema]",
            "lexical_commit_sha": "[recursive or deeply nested schema]"
          }
        },
        "sha": "string",
        "user": {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "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": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        }
      },
      "_links": {
        "comments": {
          "href": "string"
        },
        "commits": {
          "href": "string"
        },
        "statuses": {
          "href": "string"
        },
        "html": {
          "href": "string"
        },
        "issue": {
          "href": "string"
        },
        "review_comments": {
          "href": "string"
        },
        "review_comment": {
          "href": "string"
        },
        "self": {
          "href": "string"
        }
      },
      "author_association": "OWNER",
      "auto_merge": {
        "enabled_by": {
          "name": "string",
          "email": "string",
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
          "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": true,
          "starred_at": "\"2020-07-09T00:17:55Z\"",
          "user_view_type": "public"
        },
        "merge_method": "merge",
        "commit_title": "string",
        "commit_message": "string"
      },
      "stack": {
        "base": {
          "ref": "string",
          "sha": "string"
        },
        "size": 0,
        "position": 0,
        "id": 0,
        "number": 0
      },
      "draft": false
    }
  ]
}
Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.