Skip to main content

suites

Overview

Namesuites
TypeResource
Idgithub.checks.suites

Fields

NameDatatypeDescription
idinteger
afterstring
appobjectGitHub 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.
beforestring
check_runs_urlstring
conclusionstring
created_atstring
head_branchstring
head_commitobjectA commit.
head_shastringThe SHA of the head commit that is being checked.
latest_check_runs_countinteger
node_idstring
pull_requestsarray
repositoryobjectMinimal Repository
rerequestableboolean
runs_rerequestableboolean
statusstring
updated_atstring
urlstring

Methods

NameAccessible byRequired ParamsDescription
get_suiteSELECTcheck_suite_id, owner, repoNote: 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.
list_suites_for_refSELECTowner, ref, repoNote: 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.
create_suiteINSERTowner, repo, data__head_shaNote: 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.
rerequest_suiteEXECcheck_suite_id, owner, repoTriggers 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:write permission on a private repository or pull access to a public repository.
set_suites_preferencesEXECowner, repoChanges 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.