check_suite_id parameter
Get 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
.
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.
Path Parameters
Response
200 application/json
Response
Response
CheckSuite
A suite of checks performed on the code of a given code change
Example:5
Example:MDEwOkNoZWNrU3VpdGU1
Example:master
The SHA of the head commit that is being checked.
Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
Allowed values:queuedin_progresscompleted
Example:completed
Allowed values:successfailureneutralcancelledskippedtimed_outaction_required
Example:neutral
Example:https://api.github.com/repos/github/hello-world/check-suites/5
Example:146e867f55c26428e5f9fade55a9bbf5e95a7912
Example:d6fde92930d4715a2b49857d24b940956b26d2d3
Show Child Parameters
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Show Child Parameters
Minimal Repository
Show Child Parameters
Simple Commit
Show Child Parameters
Path Parameters
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.
Query Parameters
Returns check runs with the specified name
.
Returns check runs with the specified status
. Can be one of queued
, in_progress
, or completed
.
Allowed values:queuedin_progresscompleted
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
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
check_suite_id parameter
Response
200 application/json
Response
Response
A check performed on the code of a given code change
Show Child Parameters
Path Parameters
Query Parameters
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.
Path Parameters
check_suite_id parameter
Response
201 application/json
Response
Response
Path Parameters
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.
Query Parameters
Returns check runs with the specified name
.
Returns check runs with the specified status
. Can be one of queued
, in_progress
, or completed
.
Allowed values:queuedin_progresscompleted
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
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
ref parameter
Response
200 application/json
Response
Response
A check performed on the code of a given code change
Show Child Parameters
Path Parameters
Query Parameters
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.
Query Parameters
Filters check suites by GitHub App id
.
Example:1
Returns check runs with the specified name
.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
ref parameter
Response
200 application/json
Response
Response
A suite of checks performed on the code of a given code change