suites

Overview

Name	suites
Type	Resource
Id	github.checks.suites

Fields

Name	Datatype	Description
id	integer
after	string
app	object	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.
before	string
check_runs_url	string
conclusion	string
created_at	string
head_branch	string
head_commit	object	A commit.
head_sha	string	The SHA of the head commit that is being checked.
latest_check_runs_count	integer
node_id	string
pull_requests	array
repository	object	Minimal Repository
rerequestable	boolean
runs_rerequestable	boolean
status	string
updated_at	string
url	string

Methods

Name	Accessible by	Required Params	Description
get_suite	SELECT	check_suite_id, owner, repo	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.
list_suites_for_ref	SELECT	owner, ref, repo	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.
create_suite	INSERT	owner, repo, data__head_sha	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. 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_suite	EXEC	check_suite_id, owner, repo	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:write permission on a private repository or pull access to a public repository.
set_suites_preferences	EXEC	owner, repo	Changes 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.