Skip to main content
Manja / GitHub
Schema1.1.4object

check-suite

A suite of checks performed on the code of a given code change

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

CheckSuite

object

A suite of checks performed on the code of a given code change

after string
requirednullable

Example:d6fde92930d4715a2b49857d24b940956b26d2d3

app GitHub app object
requirednullable

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
requirednullable

Example:146e867f55c26428e5f9fade55a9bbf5e95a7912

check_runs_url string
required
conclusion string
requirednullable

Example:neutral

Allowed: "success""failure""neutral""cancelled""skipped""timed_out""action_required"

created_at string (date-time)
requirednullable
head_branch string
requirednullable

Example:master

head_sha string
required

The SHA of the head commit that is being checked.

Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

id integer
required

Example:5

latest_check_runs_count integer
required
node_id string
required

Example:MDEwOkNoZWNrU3VpdGU1

pull_requests array
requirednullable
rerequestable boolean
optional
runs_rerequestable boolean
optional
status string
requirednullable

Example:completed

Allowed: "queued""in_progress""completed"

updated_at string (date-time)
requirednullable
url string
requirednullable

Example:https://api.github.com/repos/github/hello-world/check-suites/5