List check runs in 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.
Lists check runs for a 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 runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
Query Parameters
check_namestring
Returns check runs with the specified name.
statusstring
Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
Allowed values:queuedin_progresscompleted
filterstring
Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
Allowed values:latestall
Default:latest
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
check_suite_idintegerrequired
check_suite_id parameter
Response
200 application/json
Response
200 application/json
Response
total_countintegerrequired
check_runsarray[object]required
A check performed on the code of a given code change
Show Child Parameters
get/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
Path Parameters
Query Parameters
200 application/json
Rerequest a check suite
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.
post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
Path Parameters
ownerstringrequired
repostringrequired
check_suite_idintegerrequired
check_suite_id parameter
Response
201 application/json
Response
201 application/json
Response
object
* Additional properties are NOT allowed.
post/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
Path Parameters
201 application/json
List check runs for a Git reference
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.
Lists check runs 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 get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/commits/{ref}/check-runs
Query Parameters
check_namestring
Returns check runs with the specified name.
statusstring
Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
Allowed values:queuedin_progresscompleted
filterstring
Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
Allowed values:latestall
Default:latest
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
app_idinteger
Path Parameters
ownerstringrequired
repostringrequired
refstringrequired
ref parameter
Response
200 application/json
Response
200 application/json
Response
total_countintegerrequired
check_runsarray[object]required
A check performed on the code of a given code change
Show Child Parameters
get/repos/{owner}/{repo}/commits/{ref}/check-runs
Path Parameters
Query Parameters
200 application/json
List check suites for a Git reference
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.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/commits/{ref}/check-suites
Query Parameters
app_idinteger
Filters check suites by GitHub App id.
Example:1
check_namestring
Returns check runs with the specified name.
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
refstringrequired
ref parameter
Response
200 application/json
Response
200 application/json
Response
total_countintegerrequired
check_suitesarray[object]required
A suite of checks performed on the code of a given code change
Show Child Parameters
get/repos/{owner}/{repo}/commits/{ref}/check-suites
Path Parameters
Query Parameters
200 application/json
code-scanning
Retrieve code scanning alerts from a repository.