GitHub v3 REST API

Simple Commit

object

Simple Commit

idstringrequired
tree_idstringrequired
messagestringrequired
timestampstring(date-time)required
authorobjectrequired
Show Child Parameters
committerobjectrequired
Show Child Parameters
Example

CheckSuite

object

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

idintegerrequired

Example:5

node_idstringrequired

Example:MDEwOkNoZWNrU3VpdGU1

head_branchstringrequired

Example:master

head_shastringrequired

The SHA of the head commit that is being checked.

Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

statusstringrequired

Allowed values:queuedin_progresscompleted

Example:completed

conclusionstringrequired

Allowed values:successfailureneutralcancelledskippedtimed_outaction_required

Example:neutral

urlstringrequired

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

beforestringrequired

Example:146e867f55c26428e5f9fade55a9bbf5e95a7912

afterstringrequired

Example:d6fde92930d4715a2b49857d24b940956b26d2d3

pull_requestsarray[object]required
Show Child Parameters
appobjectrequired

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
repositoryobjectrequired

Minimal Repository

Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
head_commitobjectrequired

Simple Commit

Show Child Parameters
latest_check_runs_countintegerrequired
check_runs_urlstringrequired
rerequestableboolean
runs_rerequestableboolean
Example

Check Suite Preference

object

Check suite configuration preferences for a repository.

preferencesobjectrequired
Show Child Parameters
repositoryobjectrequired

Minimal Repository

Show Child Parameters
Example

code-scanning-analysis-tool-name

string

The name of the tool used to generate the code scanning analysis.

code-scanning-analysis-tool-guid

string

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.