Skip to main content
이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

검사 실행에 대한 REST API 엔드포인트

REST API를 사용하여 검사 실행을 관리합니다.

참고: REST API가 검사와 상호 작용할 수 있는 쓰기 권한은 GitHub Apps에서만 사용할 수 있습니다. OAuth apps 및 인증된 사용자는 검사 실행을 보고 제품군을 확인할 수 있지만 만들 수는 없습니다. GitHub App을(를) 빌드하지 않는 경우 REST API를 사용하여 커밋 상태와 상호 작용하는 데 관심이 있을 수 있습니다.

Create a check run

Creates a new check run for a specific commit in a repository.

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

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.

"Create a check run"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (write)

"Create a check run"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

본문 매개 변수
이름, Type, 설명
name string Required

The name of the check. For example, "code-coverage".

head_sha string Required

The SHA of the commit.

details_url string

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

external_id string

A reference for the run on the integrator's system.

status string

The current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested.

기본값: queued

다음 중 하나일 수 있습니다.: queued, in_progress, completed, waiting, requested, pending

started_at string

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

conclusion string

Required if you provide completed_at or a status of completed. The final conclusion of the check. Note: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

다음 중 하나일 수 있습니다.: action_required, cancelled, failure, neutral, success, skipped, stale, timed_out

completed_at string

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

output object

Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run.

이름, Type, 설명
title string Required

The title of the check run.

summary string Required

The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.

text string

The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters.

annotations array of objects

Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "About status checks".

이름, Type, 설명
path string Required

The path of the file to add an annotation to. For example, assets/css/main.css.

start_line integer Required

The start line of the annotation. Line numbers start at 1.

end_line integer Required

The end line of the annotation.

start_column integer

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.

end_column integer

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

annotation_level string Required

The level of the annotation.

다음 중 하나일 수 있습니다.: notice, warning, failure

message string Required

A short description of the feedback for these lines of code. The maximum size is 64 KB.

title string

The title that represents the annotation. The maximum size is 255 characters.

raw_details string

Details about this annotation. The maximum size is 64 KB.

images array of objects

Adds images to the output displayed in the GitHub pull request UI.

이름, Type, 설명
alt string Required

The alternative text for the image.

image_url string Required

The full URL of the image.

caption string

A short image description.

actions array of objects

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "Check runs and requested actions."

이름, Type, 설명
label string Required

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

description string Required

A short explanation of what this action would do. The maximum size is 40 characters.

identifier string Required

A reference for the action on the integrator's system. The maximum size is 20 characters.

"Create a check run"에 대한 HTTP 응답 상태 코드

상태 코드설명
201

Created

"Create a check run"에 대한 코드 샘플

요청 예제

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":""}}'

Response for in_progress conclusion

Status: 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" } } } ] }

Get a check run

Gets a single check run using its id.

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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

"Get a check run"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"Get a check run"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

check_run_id integer Required

The unique identifier of the check run.

"Get a check run"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get a check run"에 대한 코드 샘플

요청 예제

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

Response

Status: 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" } } } ] }

Update a check run

Updates a check run for a specific commit in a repository.

Note: The endpoints to manage checks only look 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.

OAuth apps and personal access tokens (classic) cannot use this endpoint.

"Update a check run"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (write)

"Update a check run"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

check_run_id integer Required

The unique identifier of the check run.

본문 매개 변수
이름, Type, 설명
name string

The name of the check. For example, "code-coverage".

details_url string

The URL of the integrator's site that has the full details of the check.

external_id string

A reference for the run on the integrator's system.

started_at string

This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

status string

The current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested.

다음 중 하나일 수 있습니다.: queued, in_progress, completed, waiting, requested, pending

conclusion string

Required if you provide completed_at or a status of completed. The final conclusion of the check. Note: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

다음 중 하나일 수 있습니다.: action_required, cancelled, failure, neutral, success, skipped, stale, timed_out

completed_at string

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

output object

Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run.

이름, Type, 설명
title string

Required.

summary string Required

Can contain Markdown.

text string

Can contain Markdown.

annotations array of objects

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "About status checks".

이름, Type, 설명
path string Required

The path of the file to add an annotation to. For example, assets/css/main.css.

start_line integer Required

The start line of the annotation. Line numbers start at 1.

end_line integer Required

The end line of the annotation.

start_column integer

The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.

end_column integer

The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

annotation_level string Required

The level of the annotation.

다음 중 하나일 수 있습니다.: notice, warning, failure

message string Required

A short description of the feedback for these lines of code. The maximum size is 64 KB.

title string

The title that represents the annotation. The maximum size is 255 characters.

raw_details string

Details about this annotation. The maximum size is 64 KB.

images array of objects

Adds images to the output displayed in the GitHub pull request UI.

이름, Type, 설명
alt string Required

The alternative text for the image.

image_url string Required

The full URL of the image.

caption string

A short image description.

actions array of objects

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "Check runs and requested actions."

이름, Type, 설명
label string Required

The text to be displayed on a button in the web UI. The maximum size is 20 characters.

description string Required

A short explanation of what this action would do. The maximum size is 40 characters.

identifier string Required

A reference for the action on the integrator's system. The maximum size is 20 characters.

"Update a check run"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Update a check run"에 대한 코드 샘플

요청 예제

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"}]}}'

Response

Status: 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" } } } ] }

List check run annotations

Lists annotations for a check run using the annotation id.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

"List check run annotations"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"List check run annotations"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

check_run_id integer Required

The unique identifier of the check run.

쿼리 매개 변수
이름, Type, 설명
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

기본값: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

기본값: 1

"List check run annotations"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"List check run annotations"에 대한 코드 샘플

요청 예제

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

Response

Status: 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" } ]

Rerequest a check run

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

For more information about how to re-run GitHub Actions jobs, see "Re-run a job from a workflow run".

OAuth apps and personal access tokens (classic) cannot use this endpoint.

"Rerequest a check run"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (write)

"Rerequest a check run"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

check_run_id integer Required

The unique identifier of the check run.

"Rerequest a check run"에 대한 HTTP 응답 상태 코드

상태 코드설명
201

Created

403

Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App

404

Resource not found

422

Validation error if the check run is not rerequestable

"Rerequest a check run"에 대한 코드 샘플

요청 예제

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

Response

List check runs in a check suite

Lists check runs for a check suite using its id.

Note: The endpoints to manage checks only look 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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

"List check runs in a check suite"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"List check runs in a check suite"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

check_suite_id integer Required

The unique identifier of the check suite.

쿼리 매개 변수
이름, Type, 설명
check_name string

Returns check runs with the specified name.

status string

Returns check runs with the specified status.

다음 중 하나일 수 있습니다.: queued, in_progress, completed

filter string

Filters check runs by their completed_at timestamp. latest returns the most recent check runs.

기본값: latest

다음 중 하나일 수 있습니다.: latest, all

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

기본값: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

기본값: 1

"List check runs in a check suite"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"List check runs in a check suite"에 대한 코드 샘플

요청 예제

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

Response

Status: 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" } } } ] } ] }

List check runs for a Git reference

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.

Note: The endpoints to manage checks only look 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.

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

"List check runs for a Git reference"에 대한 세분화된 액세스 토큰

This endpoint works with the following fine-grained token types:

토큰에 다음 권한 집합이 있어야 합니다.:

  • "Checks" repository permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"List check runs for a Git reference"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

ref string Required

The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.

쿼리 매개 변수
이름, Type, 설명
check_name string

Returns check runs with the specified name.

status string

Returns check runs with the specified status.

다음 중 하나일 수 있습니다.: queued, in_progress, completed

filter string

Filters check runs by their completed_at timestamp. latest returns the most recent check runs.

기본값: latest

다음 중 하나일 수 있습니다.: latest, all

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

기본값: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

기본값: 1

app_id integer

"List check runs for a Git reference"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"List check runs for a Git reference"에 대한 코드 샘플

요청 예제

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

Response

Status: 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" } } } ] } ] }