检查运行的 REST API 端点

创建检查运行

为存储库中的特定提交创建新的检查运行。

要创建检查运行，您必须使用 GitHub 应用。OAuth 应用和经过身份验证的用户无法创建检查套件。

在检查套件中，GitHub 将具有相同名称的检查运行数量限制为 1000。一旦这些检查运行超过 1000，GitHub 将开始自动删除较旧的检查运行。

注意：检查 API 仅查找创建检查套件或检查运行的存储库中的推送。不会检测到对 fork 存储库中的分支的推送，并返回一个空的 pull_requests 数组。

“创建检查运行”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（写入）

“创建检查运行”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。

名称、类型、说明

name string 必需

检查的名称。例如，“code-coverage”。

head_sha string 必需

提交的 SHA。

details_url string

拥有检查完整详细信息的集成商网站的 URL。如果集成商未提供此信息，则使用 GitHub 应用的主页。

external_id string

集成器系统中运行的参考。

status 字符串

检查运行的当前状态。只有 GitHub Actions 可以设置 waiting、pending 或 requested 状态。

默认: queued

可以是: queued, in_progress, completed, waiting, requested, pending

started_at 字符串

检查运行开始的时间。这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

conclusion 字符串

如果您提供 completed_at 或 status 为 completed，则必需。检查的最终结论。注意：提供 conclusion 将自动将 status 参数设置为 completed。您不能将检查运行结论更改为 stale，只有 GitHub 可以设置此项。

可以是: action_required, cancelled, failure, neutral, success, skipped, stale, timed_out

completed_at 字符串

检查完成的时间。这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

output 对象

检查运行可以在 output 对象中接受各种数据，包括 title 和 summary，还可以选择提供有关运行的描述性详细信息。

output 的属性

名称、类型、说明

title 字符串必需

检查运行的标题。

summary 字符串必需

检查运行的摘要。此参数支持 Markdown。最大长度：65535 个字符。

text 字符串

检查运行的详细信息。此参数支持 Markdown。最大长度：65535 个字符。

annotations 对象数组

将分析信息添加到特定代码行。可在 GitHub 中的拉取请求的检查和已更改文件选项卡中看到注释。Checks API 将每个 API 请求的注释数量限制为最多 50 个。若要创建超过 50 个注释，您必须对更新检查运行端点发出多个请求。每次更新检查运行时，都会将注释追加到已存在的检查运行注释列表中。GitHub Actions 每步最多限制 10 个警告注释和 10 个错误注释。有关如何在 GitHub 上查看注释的详细信息，请参阅“关于状态检查”。

annotations 的属性

名称、类型、说明
`path` 字符串必需要添加注释的文件路径。例如，`assets/css/main.css`。
`start_line` 整数必需注释的起始行。行号从 1 开始。
`end_line` 整数必需注释的结束行。
`start_column` 整数注释的起始列。注释仅支持同一行上的 `start_column` 和 `end_column`。如果 `start_line` 和 `end_line` 具有不同的值，则省略此参数。列号从 1 开始。
`end_column` 整数注释的结束列。注释仅支持同一行上的 `start_column` 和 `end_column`。如果 `start_line` 和 `end_line` 具有不同的值，则省略此参数。
`annotation_level` 字符串必需注释的级别。可以是以下之一: `notice`, `warning`, `failure`
`message` 字符串必需对这些代码行的反馈的简短描述。最大大小为 64 KB。
`标题` 字符串表示注释的标题。最大长度为 255 个字符。
`raw_details` 字符串有关此注释的详细信息。最大长度为 64 KB。

images 对象数组

将图片添加到 GitHub Pull Request UI 中显示的输出中。

images 的属性

名称、类型、说明
`alt` 字符串必需图片的替代文本。
`image_url` 字符串必需图片的完整 URL。
`caption` 字符串简短的图片说明。

actions 对象数组

在 GitHub 上显示一个按钮，可以单击该按钮来提醒你的应用执行其他任务。例如，代码 linting 应用可以显示一个按钮，自动修复检测到的错误。在此对象中创建的按钮将在检查运行完成后显示。当用户单击该按钮时，GitHub 会向你的应用发送 check_run.requested_action webhook。每个操作都包含一个 label、identifier 和 description。最多接受三个操作。要详细了解检查运行和请求的操作，请参阅“检查运行和请求的操作”。

actions 的属性

名称、类型、说明
`label` 字符串必需在 Web UI 中按钮上显示的文本。最大长度为 20 个字符。
`description` 字符串必需此操作将执行的操作的简短说明。最大长度为 40 个字符。
`identifier` 字符串必需集成商系统中操作的引用。最大长度为 20 个字符。

“创建检查运行”的 HTTP 响应状态代码

状态代码	说明
`201`	已创建

“创建检查运行”的代码示例

请求示例

选择示例类型

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

curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/check-runs \ -d '{"name":"mighty_readme","head_sha":"ce587453ced02b1526dfb4cb910479d431683101","status":"in_progress","external_id":"42","started_at":"2018-05-04T01:14:52Z","output":{"title":"Mighty Readme report","summary":"","text":""}}'

正在进行结论的响应

状态：201

{
  "id": 4,
  "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
  "node_id": "MDg6Q2hlY2tSdW40",
  "external_id": "42",
  "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
  "html_url": "https://github.com/github/hello-world/runs/4",
  "details_url": "https://example.com",
  "status": "in_progress",
  "conclusion": null,
  "started_at": "2018-05-04T01:14:52Z",
  "completed_at": null,
  "output": {
    "title": "Mighty Readme report",
    "summary": "There are 0 failures, 2 warnings, and 1 notice.",
    "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
    "annotations_count": 2,
    "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
  },
  "name": "mighty_readme",
  "check_suite": {
    "id": 5
  },
  "app": {
    "id": 1,
    "slug": "octoapp",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://api.github.com/orgs/github",
      "repos_url": "https://api.github.com/orgs/github/repos",
      "events_url": "https://api.github.com/orgs/github/events",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "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",
      "received_events_url": "https://api.github.com/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"
    ]
  },
  "pull_requests": [
    {
      "url": "https://api.github.com/repos/github/hello-world/pulls/1",
      "id": 1934,
      "number": 3956,
      "head": {
        "ref": "say-hello",
        "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
        "repo": {
          "id": 526,
          "url": "https://api.github.com/repos/github/hello-world",
          "name": "hello-world"
        }
      },
      "base": {
        "ref": "master",
        "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
        "repo": {
          "id": 526,
          "url": "https://api.github.com/repos/github/hello-world",
          "name": "hello-world"
        }
      }
    }
  ]
}

获取检查运行

使用其 id 获取单个检查运行。

注意：检查 API 仅查找创建检查套件或检查运行的存储库中的推送。不会检测到对 fork 存储库中的分支的推送，并返回一个空的 pull_requests 数组。

OAuth 应用令牌和个人访问令牌（经典）需要 repo 范围才能在私有存储库上使用此端点。

“获取检查运行”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“获取检查运行”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。
`check_run_id` 整数必需检查运行的唯一标识符。

“获取检查运行”的 HTTP 响应状态代码

状态代码	说明
`200`	确定

“获取检查运行”的代码示例

请求示例

get/repos/{owner}/{repo}/check-runs/{check_run_id}

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/check-runs/CHECK_RUN_ID

响应

状态：200

{
  "id": 4,
  "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
  "node_id": "MDg6Q2hlY2tSdW40",
  "external_id": "",
  "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
  "html_url": "https://github.com/github/hello-world/runs/4",
  "details_url": "https://example.com",
  "status": "completed",
  "conclusion": "neutral",
  "started_at": "2018-05-04T01:14:52Z",
  "completed_at": "2018-05-04T01:14:52Z",
  "output": {
    "title": "Mighty Readme report",
    "summary": "There are 0 failures, 2 warnings, and 1 notice.",
    "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
    "annotations_count": 2,
    "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
  },
  "name": "mighty_readme",
  "check_suite": {
    "id": 5
  },
  "app": {
    "id": 1,
    "slug": "octoapp",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://api.github.com/orgs/github",
      "repos_url": "https://api.github.com/orgs/github/repos",
      "events_url": "https://api.github.com/orgs/github/events",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "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",
      "received_events_url": "https://api.github.com/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"
    ]
  },
  "pull_requests": [
    {
      "url": "https://api.github.com/repos/github/hello-world/pulls/1",
      "id": 1934,
      "number": 3956,
      "head": {
        "ref": "say-hello",
        "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
        "repo": {
          "id": 526,
          "url": "https://api.github.com/repos/github/hello-world",
          "name": "hello-world"
        }
      },
      "base": {
        "ref": "master",
        "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
        "repo": {
          "id": 526,
          "url": "https://api.github.com/repos/github/hello-world",
          "name": "hello-world"
        }
      }
    }
  ]
}

更新检查运行

更新存储库中特定提交的检查运行。

注意：管理检查的端点仅查找创建检查套件或检查运行时存储库中的推送。不会检测到对 fork 存储库中分支的推送，并返回一个空的 pull_requests 数组。

OAuth 应用和个人访问令牌（经典版）不能使用此端点。

“更新检查运行”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（写入）

“更新检查运行”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。
`check_run_id` 整数必需检查运行的唯一标识符。

名称、类型、说明

name 字符串

检查的名称。例如，“code-coverage”。

details_url string

集成商网站的 URL，其中包含检查的详细信息。

external_id string

集成器系统中运行的参考。

started_at 字符串

这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

status 字符串

检查运行的当前状态。只有 GitHub Actions 可以设置 waiting、pending 或 requested 状态。

可以是: queued, in_progress, completed, waiting, requested, pending

conclusion 字符串

可以是: action_required, cancelled, failure, neutral, success, skipped, stale, timed_out

completed_at 字符串

检查完成的时间。这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

output 对象

检查运行可以在 output 对象中接受各种数据，包括 title 和 summary，还可以选择提供有关运行的描述性详细信息。

output 的属性

名称、类型、说明

标题 字符串

必需.

summary 字符串必需

可以包含 Markdown。

text 字符串

可以包含 Markdown。

annotations 对象数组

将分析信息添加到特定代码行。注释在 GitHub 的拉取请求 UI 中可见。注释在 GitHub 的拉取请求 UI 中可见。Checks API 将注释数量限制为每个 API 请求最多 50 个。要创建超过 50 个注释，您必须对更新检查运行端点发出多个请求。每次更新检查运行时，注释都会附加到已为检查运行存在的注释列表中。GitHub Actions 每一步最多限制 10 个警告注释和 10 个错误注释。有关 UI 中注释的详细信息，请参阅“关于状态检查”。

annotations 的属性

名称、类型、说明
`path` 字符串必需要添加注释的文件路径。例如，`assets/css/main.css`。
`start_line` 整数必需注释的起始行。行号从 1 开始。
`end_line` 整数必需注释的结束行。
`start_column` 整数注释的起始列。注释仅支持同一行上的 `start_column` 和 `end_column`。如果 `start_line` 和 `end_line` 具有不同的值，则省略此参数。列号从 1 开始。
`end_column` 整数注释的结束列。注释仅支持同一行上的 `start_column` 和 `end_column`。如果 `start_line` 和 `end_line` 具有不同的值，则省略此参数。
`annotation_level` 字符串必需注释的级别。可以是以下之一: `notice`, `warning`, `failure`
`message` 字符串必需对这些代码行的反馈的简短描述。最大大小为 64 KB。
`标题` 字符串表示注释的标题。最大长度为 255 个字符。
`raw_details` 字符串有关此注释的详细信息。最大长度为 64 KB。

images 对象数组

将图片添加到 GitHub Pull Request UI 中显示的输出中。

images 的属性

名称、类型、说明
`alt` 字符串必需图片的替代文本。
`image_url` 字符串必需图片的完整 URL。
`caption` 字符串简短的图片说明。

actions 对象数组

集成商可以执行的可能的进一步操作，用户可以触发这些操作。每个操作都包括一个 label、identifier 和 description。最多接受三个操作。要详细了解检查运行和请求的操作，请参阅“检查运行和请求的操作”。

actions 的属性

名称、类型、说明
`label` 字符串必需在 Web UI 中按钮上显示的文本。最大长度为 20 个字符。
`description` 字符串必需此操作将执行的操作的简短说明。最大长度为 40 个字符。
`identifier` 字符串必需集成商系统中操作的引用。最大长度为 20 个字符。

“更新检查运行”的 HTTP 响应状态代码

状态代码	说明
`200`	确定

“更新检查运行”的代码示例

请求示例

patch/repos/{owner}/{repo}/check-runs/{check_run_id}

curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/check-runs/CHECK_RUN_ID \ -d '{"name":"mighty_readme","started_at":"2018-05-04T01:14:52Z","status":"completed","conclusion":"success","completed_at":"2018-05-04T01:14:52Z","output":{"title":"Mighty Readme report","summary":"There are 0 failures, 2 warnings, and 1 notices.","text":"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.","annotations":[{"path":"README.md","annotation_level":"warning","title":"Spell Checker","message":"Check your spelling for '\''banaas'\''.","raw_details":"Do you mean '\''bananas'\'' or '\''banana'\''?","start_line":2,"end_line":2},{"path":"README.md","annotation_level":"warning","title":"Spell Checker","message":"Check your spelling for '\''aples'\''","raw_details":"Do you mean '\''apples'\'' or '\''Naples'\''","start_line":4,"end_line":4}],"images":[{"alt":"Super bananas","image_url":"http://example.com/images/42"}]}}'

响应

状态：200

{
  "id": 4,
  "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
  "node_id": "MDg6Q2hlY2tSdW40",
  "external_id": "",
  "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
  "html_url": "https://github.com/github/hello-world/runs/4",
  "details_url": "https://example.com",
  "status": "completed",
  "conclusion": "neutral",
  "started_at": "2018-05-04T01:14:52Z",
  "completed_at": "2018-05-04T01:14:52Z",
  "output": {
    "title": "Mighty Readme report",
    "summary": "There are 0 failures, 2 warnings, and 1 notice.",
    "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
    "annotations_count": 2,
    "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
  },
  "name": "mighty_readme",
  "check_suite": {
    "id": 5
  },
  "app": {
    "id": 1,
    "slug": "octoapp",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://api.github.com/orgs/github",
      "repos_url": "https://api.github.com/orgs/github/repos",
      "events_url": "https://api.github.com/orgs/github/events",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "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",
      "received_events_url": "https://api.github.com/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"
    ]
  },
  "pull_requests": [
    {
      "url": "https://api.github.com/repos/github/hello-world/pulls/1",
      "id": 1934,
      "number": 3956,
      "head": {
        "ref": "say-hello",
        "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
        "repo": {
          "id": 526,
          "url": "https://api.github.com/repos/github/hello-world",
          "name": "hello-world"
        }
      },
      "base": {
        "ref": "master",
        "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
        "repo": {
          "id": 526,
          "url": "https://api.github.com/repos/github/hello-world",
          "name": "hello-world"
        }
      }
    }
  ]
}

列出检查运行注释

使用注释id列出检查运行的注释。

OAuth 应用令牌和个人访问令牌（经典）需要 repo 范围才能在私有存储库上使用此端点。

“列出检查运行注释”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出检查运行注释”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。
`check_run_id` 整数必需检查运行的唯一标识符。

查询参数
名称、类型、说明
`per_page` integer 每页结果数（最大 100）。有关详细信息，请参阅“在 REST API 中使用分页”。默认: `30`
`page` integer 要获取的结果的页码。有关详细信息，请参阅“在 REST API 中使用分页”。默认: `1`

“列出检查运行注释”的 HTTP 响应状态代码

状态代码	说明
`200`	确定

“列出检查运行注释”的代码示例

请求示例

get/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/check-runs/CHECK_RUN_ID/annotations

响应

状态：200

[ { "path": "README.md", "start_line": 2, "end_line": 2, "start_column": 5, "end_column": 10, "annotation_level": "warning", "title": "Spell Checker", "message": "Check your spelling for 'banaas'.", "raw_details": "Do you mean 'bananas' or 'banana'?", "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc" } ]

重新请求检查运行

触发 GitHub 重新请求现有的检查运行，而无需将新代码推送到存储库。此端点将触发带有操作 rerequested 的 check_run webhook 事件。当检查运行 rerequested 时，其 status 重置为 queued，且 conclusion 被清除。

有关如何重新运行 GitHub Actions 作业的更多信息，请参阅“从工作流运行重新运行作业”。

OAuth 应用和个人访问令牌（经典版）不能使用此端点。

“重新请求检查运行”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（写入）

“重新请求检查运行”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。
`check_run_id` 整数必需检查运行的唯一标识符。

“重新请求检查运行”的 HTTP 响应状态代码

状态代码	说明
`201`	已创建
`403`	如果检查运行不可重新请求或不属于经过身份验证的 GitHub 应用程序，则禁止
`404`	资源未找到
`422`	如果检查运行不可重新请求，则验证错误

“重新请求检查运行”的代码示例

请求示例

post/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest

curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/check-runs/CHECK_RUN_ID/rerequest

响应

状态：201

列出检查套件中的检查运行

使用其 id 列出检查套件的检查运行。

OAuth 应用令牌和个人访问令牌（经典）需要 repo 范围才能在私有存储库上使用此端点。

“列出检查套件中的检查运行”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出检查套件中的检查运行”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。
`check_suite_id` integer Required 检查套件的唯一标识符。

查询参数
名称、类型、说明
`check_name` string 返回具有指定 `name` 的检查运行。
`status` 字符串返回具有指定 `status` 的检查运行。可以是以下之一：: `queued`, `in_progress`, `completed`
`filter` string 按其 `completed_at` 时间戳筛选检查运行。`latest` 返回最新的检查运行。默认: `latest` 可以是: `latest`, `all`
`per_page` integer 每页结果数（最大 100）。有关详细信息，请参阅“在 REST API 中使用分页”。默认: `30`
`page` integer 要获取的结果的页码。有关详细信息，请参阅“在 REST API 中使用分页”。默认: `1`

“列出检查套件中的检查运行”的 HTTP 响应状态代码

状态代码	说明
`200`	确定

“列出检查套件中的检查运行”的代码示例

请求示例

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

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/check-suites/CHECK_SUITE_ID/check-runs

响应

状态：200

{
  "total_count": 1,
  "check_runs": [
    {
      "id": 4,
      "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
      "node_id": "MDg6Q2hlY2tSdW40",
      "external_id": "",
      "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
      "html_url": "https://github.com/github/hello-world/runs/4",
      "details_url": "https://example.com",
      "status": "completed",
      "conclusion": "neutral",
      "started_at": "2018-05-04T01:14:52Z",
      "completed_at": "2018-05-04T01:14:52Z",
      "output": {
        "title": "Mighty Readme report",
        "summary": "There are 0 failures, 2 warnings, and 1 notice.",
        "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
        "annotations_count": 2,
        "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
      },
      "name": "mighty_readme",
      "check_suite": {
        "id": 5
      },
      "app": {
        "id": 1,
        "slug": "octoapp",
        "node_id": "MDExOkludGVncmF0aW9uMQ==",
        "owner": {
          "login": "github",
          "id": 1,
          "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
          "url": "https://api.github.com/orgs/github",
          "repos_url": "https://api.github.com/orgs/github/repos",
          "events_url": "https://api.github.com/orgs/github/events",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "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",
          "received_events_url": "https://api.github.com/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"
        ]
      },
      "pull_requests": [
        {
          "url": "https://api.github.com/repos/github/hello-world/pulls/1",
          "id": 1934,
          "number": 3956,
          "head": {
            "ref": "say-hello",
            "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
            "repo": {
              "id": 526,
              "url": "https://api.github.com/repos/github/hello-world",
              "name": "hello-world"
            }
          },
          "base": {
            "ref": "master",
            "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
            "repo": {
              "id": 526,
              "url": "https://api.github.com/repos/github/hello-world",
              "name": "hello-world"
            }
          }
        }
      ]
    }
  ]
}

列出 Git 引用检查运行

列出提交 ref 的检查运行。ref 可以是 SHA、分支名称或标签名称。

如果单个 git 引用上有 1000 个以上的检查套件，此端点会将检查运行限制为最近的 1000 个检查套件。要迭代所有可能的检查运行，请使用列出 Git 引用检查套件端点，并向列出检查套件中的检查运行端点提供 check_suite_id 参数。

OAuth 应用令牌和个人访问令牌（经典）需要 repo 范围才能在私有存储库上使用此端点。

“列出 Git 引用检查运行”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌必须具有以下权限设置

“检查”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出 Git 引用检查运行”的参数

标头
名称、类型、说明
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、说明
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。
`ref` 字符串必需提交引用。可以是提交 SHA、分支名称 (`heads/BRANCH_NAME`) 或标签名称 (`tags/TAG_NAME`)。有关更多信息，请参阅 Git 文档中的“Git 引用”。

查询参数
名称、类型、说明
`check_name` string 返回具有指定 `name` 的检查运行。
`status` 字符串返回具有指定 `status` 的检查运行。可以是以下之一：: `queued`, `in_progress`, `completed`
`filter` string 按其 `completed_at` 时间戳筛选检查运行。`latest` 返回最新的检查运行。默认: `latest` 可以是: `latest`, `all`
`per_page` integer 每页结果数（最大 100）。有关详细信息，请参阅“在 REST API 中使用分页”。默认: `30`
`page` integer 要获取的结果的页码。有关详细信息，请参阅“在 REST API 中使用分页”。默认: `1`
`app_id` 整数

“列出 Git 引用检查运行”的 HTTP 响应状态代码

状态代码	说明
`200`	确定

“列出 Git 引用检查运行”的代码示例

请求示例

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

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/commits/REF/check-runs

响应

状态：200

{
  "total_count": 1,
  "check_runs": [
    {
      "id": 4,
      "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
      "node_id": "MDg6Q2hlY2tSdW40",
      "external_id": "",
      "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
      "html_url": "https://github.com/github/hello-world/runs/4",
      "details_url": "https://example.com",
      "status": "completed",
      "conclusion": "neutral",
      "started_at": "2018-05-04T01:14:52Z",
      "completed_at": "2018-05-04T01:14:52Z",
      "output": {
        "title": "Mighty Readme report",
        "summary": "There are 0 failures, 2 warnings, and 1 notice.",
        "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
        "annotations_count": 2,
        "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
      },
      "name": "mighty_readme",
      "check_suite": {
        "id": 5
      },
      "app": {
        "id": 1,
        "slug": "octoapp",
        "node_id": "MDExOkludGVncmF0aW9uMQ==",
        "owner": {
          "login": "github",
          "id": 1,
          "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
          "url": "https://api.github.com/orgs/github",
          "repos_url": "https://api.github.com/orgs/github/repos",
          "events_url": "https://api.github.com/orgs/github/events",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "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",
          "received_events_url": "https://api.github.com/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"
        ]
      },
      "pull_requests": [
        {
          "url": "https://api.github.com/repos/github/hello-world/pulls/1",
          "id": 1934,
          "number": 3956,
          "head": {
            "ref": "say-hello",
            "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
            "repo": {
              "id": 526,
              "url": "https://api.github.com/repos/github/hello-world",
              "name": "hello-world"
            }
          },
          "base": {
            "ref": "master",
            "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
            "repo": {
              "id": 526,
              "url": "https://api.github.com/repos/github/hello-world",
              "name": "hello-world"
            }
          }
        }
      ]
    }
  ]
}