检查套件

使用 REST API 管理检查套件。

注意：GitHub 应用在每个提交 SHA 中仅接收一个 check_suite 事件，即使将提交 SHA 推送到多个分支也是如此。要了解何时将提交 SHA 推送到分支，可以订阅分支 create 事件。

Create a check suite

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Update repository preferences for check suites". Your GitHub App must have the checks:write permission to create check suites.

“Create a check suite”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必选 The account owner of the repository. The name is not case sensitive.
`repo` string 必选 The name of the repository. The name is not case sensitive.
正文参数
名称, 类型, 说明
`head_sha` string 必选 The sha of the head commit.

“Create a check suite”的 HTTP 响应状态代码

状态代码	说明
`200`	Response when the suite already exists
`201`	Response when the suite was created

“Create a check suite”的示例代码

post/repos/{owner}/{repo}/check-suites

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/check-suites \
  -d '{"head_sha":"d6fde92930d4715a2b49857d24b940956b26d2d3"}'

Response when the suite already exists

Status: 200

{
  "id": 5,
  "node_id": "MDEwOkNoZWNrU3VpdGU1",
  "head_branch": "master",
  "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3",
  "status": "completed",
  "conclusion": "neutral",
  "url": "https://HOSTNAME/repos/github/hello-world/check-suites/5",
  "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
  "after": "d6fde92930d4715a2b49857d24b940956b26d2d3",
  "pull_requests": [],
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "app": {
    "id": 1,
    "slug": "octoapp",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://HOSTNAME/orgs/github",
      "repos_url": "https://HOSTNAME/orgs/github/repos",
      "events_url": "https://HOSTNAME/orgs/github/events",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": true
    },
    "name": "Octocat App",
    "description": "",
    "external_url": "https://example.com",
    "html_url": "https://github.com/apps/octoapp",
    "created_at": "2017-07-08T16:18:44-04:00",
    "updated_at": "2017-07-08T16:18:44-04:00",
    "permissions": {
      "metadata": "read",
      "contents": "read",
      "issues": "write",
      "single_file": "write"
    },
    "events": [
      "push",
      "pull_request"
    ]
  },
  "repository": {
    "id": 1296269,
    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
    "name": "Hello-World",
    "full_name": "octocat/Hello-World",
    "template_repository": {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World-Template",
      "full_name": "octocat/Hello-World-Template",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://HOSTNAME/users/octocat/followers",
        "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
        "organizations_url": "https://HOSTNAME/users/octocat/orgs",
        "repos_url": "https://HOSTNAME/users/octocat/repos",
        "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World-Template",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://HOSTNAME/repos/octocat/Hello-World-Template",
      "archive_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
      "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/assignees{/user}",
      "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/blobs{/sha}",
      "branches_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/branches{/branch}",
      "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
      "comments_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/comments{/number}",
      "commits_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/commits{/sha}",
      "compare_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/compare/{base}...{head}",
      "contents_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/contents/{+path}",
      "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/contributors",
      "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/deployments",
      "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/downloads",
      "events_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/events",
      "forks_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/forks",
      "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/commits{/sha}",
      "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/refs{/sha}",
      "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/tags{/sha}",
      "git_url": "git:github.com/octocat/Hello-World-Template.git",
      "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues/comments{/number}",
      "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues/events{/number}",
      "issues_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues{/number}",
      "keys_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/keys{/key_id}",
      "labels_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/labels{/name}",
      "languages_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/languages",
      "merges_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/merges",
      "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/milestones{/number}",
      "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
      "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/pulls{/number}",
      "releases_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/releases{/id}",
      "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
      "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/stargazers",
      "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/statuses/{sha}",
      "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/subscribers",
      "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/subscription",
      "tags_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/tags",
      "teams_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/teams",
      "trees_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/trees{/sha}",
      "clone_url": "https://github.com/octocat/Hello-World-Template.git",
      "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
      "hooks_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/hooks",
      "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
      "homepage": "https://github.com",
      "language": null,
      "forks": 9,
      "forks_count": 9,
      "stargazers_count": 80,
      "watchers_count": 80,
      "watchers": 80,
      "size": 108,
      "default_branch": "master",
      "open_issues": 0,
      "open_issues_count": 0,
      "is_template": true,
      "license": {
        "key": "mit",
        "name": "MIT License",
        "url": "https://HOSTNAME/licenses/mit",
        "spdx_id": "MIT",
        "node_id": "MDc6TGljZW5zZW1pdA==",
        "html_url": "https://HOSTNAME/licenses/mit"
      },
      "topics": [
        "octocat",
        "atom",
        "electron",
        "api"
      ],
      "has_issues": true,
      "has_projects": true,
      "has_wiki": true,
      "has_pages": false,
      "has_downloads": true,
      "archived": false,
      "disabled": false,
      "visibility": "public",
      "pushed_at": "2011-01-26T19:06:43Z",
      "created_at": "2011-01-26T19:01:12Z",
      "updated_at": "2011-01-26T19:14:43Z",
      "permissions": {
        "admin": false,
        "push": false,
        "pull": true
      },
      "allow_rebase_merge": true,
      "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
      "allow_squash_merge": true,
      "allow_auto_merge": false,
      "delete_branch_on_merge": true,
      "allow_merge_commit": true,
      "subscribers_count": 42,
      "network_count": 0
    },
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "private": false,
    "html_url": "https://github.com/octocat/Hello-World",
    "description": "This your first repo!",
    "fork": false,
    "url": "https://HOSTNAME/repos/octocat/Hello-World",
    "archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
    "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
    "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
    "branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
    "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
    "comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
    "commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
    "compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
    "contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
    "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
    "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
    "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
    "events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
    "forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
    "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
    "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
    "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
    "git_url": "git:github.com/octocat/Hello-World.git",
    "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
    "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
    "issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
    "keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
    "labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
    "languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
    "merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
    "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
    "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
    "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
    "releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
    "ssh_url": "git@github.com:octocat/Hello-World.git",
    "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
    "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
    "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
    "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
    "tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
    "teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
    "trees_url": "https://HOSTNAME/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": "https://HOSTNAME/repos/octocat/Hello-World/hooks",
    "svn_url": "https://svn.github.com/octocat/Hello-World",
    "homepage": "https://github.com",
    "language": null,
    "forks_count": 9,
    "stargazers_count": 80,
    "watchers_count": 80,
    "size": 108,
    "default_branch": "master",
    "open_issues_count": 0,
    "is_template": false,
    "topics": [
      "octocat",
      "atom",
      "electron",
      "api"
    ],
    "has_issues": true,
    "has_projects": true,
    "has_wiki": true,
    "has_pages": false,
    "has_downloads": true,
    "archived": false,
    "disabled": false,
    "visibility": "public",
    "pushed_at": "2011-01-26T19:06:43Z",
    "created_at": "2011-01-26T19:01:12Z",
    "updated_at": "2011-01-26T19:14:43Z",
    "permissions": {
      "admin": false,
      "push": false,
      "pull": true
    },
    "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
    "delete_branch_on_merge": true,
    "subscribers_count": 42,
    "network_count": 0
  },
  "head_commit": {
    "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
    "timestamp": "2016-10-10T00:00:00Z",
    "author": {
      "name": "The Octocat",
      "email": "octocat@nowhere.com"
    },
    "committer": {
      "name": "The Octocat",
      "email": "octocat@nowhere.com"
    }
  },
  "latest_check_runs_count": 1,
  "check_runs_url": "https://HOSTNAME/repos/octocat/Hello-World/check-suites/5/check-runs"
}

Update repository preferences for check suites

适用于 GitHub Apps

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

“Update repository preferences for check suites”的参数

标头

名称, 类型, 说明

accept string

Setting to application/vnd.github+json is recommended.

路径参数

名称, 类型, 说明

owner string 必选

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

repo string 必选

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

正文参数

名称, 类型, 说明

auto_trigger_checks array of objects

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.

Properties of auto_trigger_checks

名称, 类型, 说明
`app_id` integer 必选 The `id` of the GitHub App.
`setting` boolean 必选 Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. 默认: `true`

“Update repository preferences for check suites”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“Update repository preferences for check suites”的示例代码

patch/repos/{owner}/{repo}/check-suites/preferences

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/check-suites/preferences \
  -d '{"auto_trigger_checks":[{"app_id":4,"setting":false}]}'

Response

Status: 200

{
  "preferences": {
    "auto_trigger_checks": [
      {
        "app_id": 2,
        "setting": true
      },
      {
        "app_id": 4,
        "setting": false
      }
    ]
  },
  "repository": {
    "id": 1296269,
    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
    "name": "Hello-World",
    "full_name": "octocat/Hello-World",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "private": false,
    "html_url": "https://github.com/octocat/Hello-World",
    "description": "This your first repo!",
    "fork": false,
    "url": "https://HOSTNAME/repos/octocat/Hello-World",
    "archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
    "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
    "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
    "branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
    "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
    "comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
    "commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
    "compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
    "contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
    "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
    "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
    "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
    "events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
    "forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
    "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
    "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
    "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
    "git_url": "git:github.com/octocat/Hello-World.git",
    "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
    "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
    "issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
    "keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
    "labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
    "languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
    "merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
    "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
    "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
    "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
    "releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
    "ssh_url": "git@github.com:octocat/Hello-World.git",
    "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
    "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
    "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
    "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
    "tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
    "teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
    "trees_url": "https://HOSTNAME/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": "https://HOSTNAME/repos/octocat/Hello-World/hooks",
    "svn_url": "https://svn.github.com/octocat/Hello-World",
    "homepage": "https://github.com",
    "language": null,
    "forks_count": 9,
    "stargazers_count": 80,
    "watchers_count": 80,
    "size": 108,
    "default_branch": "master",
    "open_issues_count": 0,
    "is_template": false,
    "topics": [
      "octocat",
      "atom",
      "electron",
      "api"
    ],
    "has_issues": true,
    "has_projects": true,
    "has_wiki": true,
    "has_pages": false,
    "has_downloads": true,
    "archived": false,
    "disabled": false,
    "visibility": "public",
    "pushed_at": "2011-01-26T19:06:43Z",
    "created_at": "2011-01-26T19:01:12Z",
    "updated_at": "2011-01-26T19:14:43Z",
    "permissions": {
      "admin": false,
      "push": false,
      "pull": true
    },
    "template_repository": {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World-Template",
      "full_name": "octocat/Hello-World-Template",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://HOSTNAME/users/octocat/followers",
        "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
        "organizations_url": "https://HOSTNAME/users/octocat/orgs",
        "repos_url": "https://HOSTNAME/users/octocat/repos",
        "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World-Template",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://HOSTNAME/repos/octocat/Hello-World-Template",
      "archive_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
      "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/assignees{/user}",
      "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/blobs{/sha}",
      "branches_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/branches{/branch}",
      "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
      "comments_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/comments{/number}",
      "commits_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/commits{/sha}",
      "compare_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/compare/{base}...{head}",
      "contents_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/contents/{+path}",
      "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/contributors",
      "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/deployments",
      "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/downloads",
      "events_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/events",
      "forks_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/forks",
      "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/commits{/sha}",
      "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/refs{/sha}",
      "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/tags{/sha}",
      "git_url": "git:github.com/octocat/Hello-World-Template.git",
      "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues/comments{/number}",
      "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues/events{/number}",
      "issues_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues{/number}",
      "keys_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/keys{/key_id}",
      "labels_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/labels{/name}",
      "languages_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/languages",
      "merges_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/merges",
      "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/milestones{/number}",
      "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
      "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/pulls{/number}",
      "releases_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/releases{/id}",
      "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
      "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/stargazers",
      "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/statuses/{sha}",
      "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/subscribers",
      "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/subscription",
      "tags_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/tags",
      "teams_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/teams",
      "trees_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/trees{/sha}",
      "clone_url": "https://github.com/octocat/Hello-World-Template.git",
      "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
      "hooks_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/hooks",
      "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
      "homepage": "https://github.com",
      "language": null,
      "forks": 9,
      "forks_count": 9,
      "stargazers_count": 80,
      "watchers_count": 80,
      "watchers": 80,
      "size": 108,
      "default_branch": "master",
      "open_issues": 0,
      "open_issues_count": 0,
      "is_template": true,
      "license": {
        "key": "mit",
        "name": "MIT License",
        "url": "https://HOSTNAME/licenses/mit",
        "spdx_id": "MIT",
        "node_id": "MDc6TGljZW5zZW1pdA==",
        "html_url": "https://HOSTNAME/licenses/mit"
      },
      "topics": [
        "octocat",
        "atom",
        "electron",
        "api"
      ],
      "has_issues": true,
      "has_projects": true,
      "has_wiki": true,
      "has_pages": false,
      "has_downloads": true,
      "archived": false,
      "disabled": false,
      "visibility": "public",
      "pushed_at": "2011-01-26T19:06:43Z",
      "created_at": "2011-01-26T19:01:12Z",
      "updated_at": "2011-01-26T19:14:43Z",
      "permissions": {
        "admin": false,
        "push": false,
        "pull": true
      },
      "allow_rebase_merge": true,
      "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
      "allow_squash_merge": true,
      "allow_auto_merge": false,
      "delete_branch_on_merge": true,
      "allow_merge_commit": true,
      "subscribers_count": 42,
      "network_count": 0
    }
  }
}

Get a check suite

适用于 GitHub Apps

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

“Get a check suite”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必选 The account owner of the repository. The name is not case sensitive.
`repo` string 必选 The name of the repository. The name is not case sensitive.
`check_suite_id` integer 必选 The unique identifier of the check suite.

“Get a check suite”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“Get a check suite”的示例代码

get/repos/{owner}/{repo}/check-suites/{check_suite_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/check-suites/CHECK_SUITE_ID

Response

Status: 200

{
  "id": 5,
  "node_id": "MDEwOkNoZWNrU3VpdGU1",
  "head_branch": "master",
  "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3",
  "status": "completed",
  "conclusion": "neutral",
  "url": "https://HOSTNAME/repos/github/hello-world/check-suites/5",
  "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
  "after": "d6fde92930d4715a2b49857d24b940956b26d2d3",
  "pull_requests": [],
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "app": {
    "id": 1,
    "slug": "octoapp",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://HOSTNAME/orgs/github",
      "repos_url": "https://HOSTNAME/orgs/github/repos",
      "events_url": "https://HOSTNAME/orgs/github/events",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": true
    },
    "name": "Octocat App",
    "description": "",
    "external_url": "https://example.com",
    "html_url": "https://github.com/apps/octoapp",
    "created_at": "2017-07-08T16:18:44-04:00",
    "updated_at": "2017-07-08T16:18:44-04:00",
    "permissions": {
      "metadata": "read",
      "contents": "read",
      "issues": "write",
      "single_file": "write"
    },
    "events": [
      "push",
      "pull_request"
    ]
  },
  "repository": {
    "id": 1296269,
    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
    "name": "Hello-World",
    "full_name": "octocat/Hello-World",
    "template_repository": {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World-Template",
      "full_name": "octocat/Hello-World-Template",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://HOSTNAME/users/octocat/followers",
        "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
        "organizations_url": "https://HOSTNAME/users/octocat/orgs",
        "repos_url": "https://HOSTNAME/users/octocat/repos",
        "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World-Template",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://HOSTNAME/repos/octocat/Hello-World-Template",
      "archive_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
      "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/assignees{/user}",
      "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/blobs{/sha}",
      "branches_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/branches{/branch}",
      "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
      "comments_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/comments{/number}",
      "commits_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/commits{/sha}",
      "compare_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/compare/{base}...{head}",
      "contents_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/contents/{+path}",
      "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/contributors",
      "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/deployments",
      "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/downloads",
      "events_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/events",
      "forks_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/forks",
      "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/commits{/sha}",
      "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/refs{/sha}",
      "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/tags{/sha}",
      "git_url": "git:github.com/octocat/Hello-World-Template.git",
      "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues/comments{/number}",
      "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues/events{/number}",
      "issues_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/issues{/number}",
      "keys_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/keys{/key_id}",
      "labels_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/labels{/name}",
      "languages_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/languages",
      "merges_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/merges",
      "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/milestones{/number}",
      "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
      "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/pulls{/number}",
      "releases_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/releases{/id}",
      "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
      "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/stargazers",
      "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/statuses/{sha}",
      "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/subscribers",
      "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/subscription",
      "tags_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/tags",
      "teams_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/teams",
      "trees_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/git/trees{/sha}",
      "clone_url": "https://github.com/octocat/Hello-World-Template.git",
      "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
      "hooks_url": "https://HOSTNAME/repos/octocat/Hello-World-Template/hooks",
      "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
      "homepage": "https://github.com",
      "language": null,
      "forks": 9,
      "forks_count": 9,
      "stargazers_count": 80,
      "watchers_count": 80,
      "watchers": 80,
      "size": 108,
      "default_branch": "master",
      "open_issues": 0,
      "open_issues_count": 0,
      "is_template": true,
      "license": {
        "key": "mit",
        "name": "MIT License",
        "url": "https://HOSTNAME/licenses/mit",
        "spdx_id": "MIT",
        "node_id": "MDc6TGljZW5zZW1pdA==",
        "html_url": "https://HOSTNAME/licenses/mit"
      },
      "topics": [
        "octocat",
        "atom",
        "electron",
        "api"
      ],
      "has_issues": true,
      "has_projects": true,
      "has_wiki": true,
      "has_pages": false,
      "has_downloads": true,
      "archived": false,
      "disabled": false,
      "visibility": "public",
      "pushed_at": "2011-01-26T19:06:43Z",
      "created_at": "2011-01-26T19:01:12Z",
      "updated_at": "2011-01-26T19:14:43Z",
      "permissions": {
        "admin": false,
        "push": false,
        "pull": true
      },
      "allow_rebase_merge": true,
      "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
      "allow_squash_merge": true,
      "allow_auto_merge": false,
      "delete_branch_on_merge": true,
      "allow_merge_commit": true,
      "subscribers_count": 42,
      "network_count": 0
    },
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "private": false,
    "html_url": "https://github.com/octocat/Hello-World",
    "description": "This your first repo!",
    "fork": false,
    "url": "https://HOSTNAME/repos/octocat/Hello-World",
    "archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
    "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
    "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
    "branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
    "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
    "comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
    "commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
    "compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
    "contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
    "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
    "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
    "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
    "events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
    "forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
    "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
    "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
    "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
    "git_url": "git:github.com/octocat/Hello-World.git",
    "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
    "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
    "issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
    "keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
    "labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
    "languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
    "merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
    "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
    "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
    "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
    "releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
    "ssh_url": "git@github.com:octocat/Hello-World.git",
    "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
    "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
    "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
    "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
    "tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
    "teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
    "trees_url": "https://HOSTNAME/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": "https://HOSTNAME/repos/octocat/Hello-World/hooks",
    "svn_url": "https://svn.github.com/octocat/Hello-World",
    "homepage": "https://github.com",
    "language": null,
    "forks_count": 9,
    "stargazers_count": 80,
    "watchers_count": 80,
    "size": 108,
    "default_branch": "master",
    "open_issues_count": 0,
    "is_template": false,
    "topics": [
      "octocat",
      "atom",
      "electron",
      "api"
    ],
    "has_issues": true,
    "has_projects": true,
    "has_wiki": true,
    "has_pages": false,
    "has_downloads": true,
    "archived": false,
    "disabled": false,
    "visibility": "public",
    "pushed_at": "2011-01-26T19:06:43Z",
    "created_at": "2011-01-26T19:01:12Z",
    "updated_at": "2011-01-26T19:14:43Z",
    "permissions": {
      "admin": false,
      "push": false,
      "pull": true
    },
    "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
    "delete_branch_on_merge": true,
    "subscribers_count": 42,
    "network_count": 0
  },
  "head_commit": {
    "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
    "timestamp": "2016-10-10T00:00:00Z",
    "author": {
      "name": "The Octocat",
      "email": "octocat@nowhere.com"
    },
    "committer": {
      "name": "The Octocat",
      "email": "octocat@nowhere.com"
    }
  },
  "latest_check_runs_count": 1,
  "check_runs_url": "https://HOSTNAME/repos/octocat/Hello-World/check-suites/5/check-runs"
}

Rerequest a check suite

适用于 GitHub Apps

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

“Rerequest a check suite”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必选 The account owner of the repository. The name is not case sensitive.
`repo` string 必选 The name of the repository. The name is not case sensitive.
`check_suite_id` integer 必选 The unique identifier of the check suite.

“Rerequest a check suite”的 HTTP 响应状态代码

状态代码	说明
`201`	Created

“Rerequest a check suite”的示例代码

post/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/check-suites/CHECK_SUITE_ID/rerequest

Response

Status: 201

List check suites for a Git reference

适用于 GitHub Apps

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

“List check suites for a Git reference”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必选 The account owner of the repository. The name is not case sensitive.
`repo` string 必选 The name of the repository. The name is not case sensitive.
`ref` string 必选 ref parameter
查询参数
名称, 类型, 说明
`app_id` integer Filters check suites by GitHub App `id`.
`check_name` string Returns check runs with the specified `name`.
`per_page` integer The number of results per page (max 100). 默认: `30`
`page` integer Page number of the results to fetch. 默认: `1`

“List check suites for a Git reference”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“List check suites for a Git reference”的示例代码

get/repos/{owner}/{repo}/commits/{ref}/check-suites

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/commits/REF/check-suites

Response

Status: 200

{
  "total_count": 1,
  "check_suites": [
    {
      "id": 5,
      "node_id": "MDEwOkNoZWNrU3VpdGU1",
      "head_branch": "master",
      "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3",
      "status": "completed",
      "conclusion": "neutral",
      "url": "https://HOSTNAME/repos/github/hello-world/check-suites/5",
      "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
      "after": "d6fde92930d4715a2b49857d24b940956b26d2d3",
      "pull_requests": [],
      "app": {
        "id": 1,
        "slug": "octoapp",
        "node_id": "MDExOkludGVncmF0aW9uMQ==",
        "owner": {
          "login": "github",
          "id": 1,
          "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
          "url": "https://HOSTNAME/orgs/github",
          "repos_url": "https://HOSTNAME/orgs/github/repos",
          "events_url": "https://HOSTNAME/orgs/github/events",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://HOSTNAME/users/octocat/followers",
          "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
          "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
          "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
          "organizations_url": "https://HOSTNAME/users/octocat/orgs",
          "received_events_url": "https://HOSTNAME/users/octocat/received_events",
          "type": "User",
          "site_admin": true
        },
        "name": "Octocat App",
        "description": "",
        "external_url": "https://example.com",
        "html_url": "https://github.com/apps/octoapp",
        "created_at": "2017-07-08T16:18:44-04:00",
        "updated_at": "2017-07-08T16:18:44-04:00",
        "permissions": {
          "metadata": "read",
          "contents": "read",
          "issues": "write",
          "single_file": "write"
        },
        "events": [
          "push",
          "pull_request"
        ]
      },
      "repository": {
        "id": 1296269,
        "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
        "name": "Hello-World",
        "full_name": "octocat/Hello-World",
        "owner": {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://HOSTNAME/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://HOSTNAME/users/octocat/followers",
          "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
          "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
          "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
          "organizations_url": "https://HOSTNAME/users/octocat/orgs",
          "repos_url": "https://HOSTNAME/users/octocat/repos",
          "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
          "received_events_url": "https://HOSTNAME/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "private": false,
        "html_url": "https://github.com/octocat/Hello-World",
        "description": "This your first repo!",
        "fork": false,
        "url": "https://HOSTNAME/repos/octocat/Hello-World",
        "archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
        "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
        "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
        "events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
        "forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
        "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
        "merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
        "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
        "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
        "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
        "tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
        "teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
        "trees_url": "https://HOSTNAME/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": "https://HOSTNAME/repos/octocat/Hello-World/hooks",
        "svn_url": "https://svn.github.com/octocat/Hello-World",
        "homepage": "https://github.com",
        "language": null,
        "forks_count": 9,
        "stargazers_count": 80,
        "watchers_count": 80,
        "size": 108,
        "default_branch": "master",
        "open_issues_count": 0,
        "is_template": true,
        "topics": [
          "octocat",
          "atom",
          "electron",
          "api"
        ],
        "has_issues": true,
        "has_projects": true,
        "has_wiki": true,
        "has_pages": false,
        "has_downloads": true,
        "archived": false,
        "disabled": false,
        "visibility": "public",
        "pushed_at": "2011-01-26T19:06:43Z",
        "created_at": "2011-01-26T19:01:12Z",
        "updated_at": "2011-01-26T19:14:43Z",
        "permissions": {
          "admin": false,
          "push": false,
          "pull": true
        },
        "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
        "delete_branch_on_merge": true,
        "subscribers_count": 42,
        "network_count": 0
      },
      "created_at": "2011-01-26T19:01:12Z",
      "updated_at": "2011-01-26T19:14:43Z",
      "head_commit": {
        "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
        "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
        "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
        "timestamp": "2016-10-10T00:00:00Z",
        "author": {
          "name": "The Octocat",
          "email": "octocat@nowhere.com"
        },
        "committer": {
          "name": "The Octocat",
          "email": "octocat@nowhere.com"
        }
      },
      "latest_check_runs_count": 1,
      "check_runs_url": "https://HOSTNAME/repos/octocat/Hello-World/check-suites/5/check-runs"
    }
  ]
}