check_suites.md

Repo / Check suites API

Back to the "Repos API" | Back to the navigation

Create a check suite

https://docs.github.com/en/rest/reference/checks#create-a-check-suite

$params = [
  'head_sha' => $commitSha, # required
];
$check = $client->api('repo')->checkSuites()->create('KnpLabs', 'php-github-api', $params);

Update check suite preferences

https://docs.github.com/en/rest/reference/checks#update-repository-preferences-for-check-suites

$params = [/*...*/];
$check = $client->api('repo')->checkSuites()->updatePreferences('KnpLabs', 'php-github-api', $params);

Get a check suite

https://docs.github.com/en/rest/reference/checks#get-a-check-suite

$check = $client->api('repo')->checkSuites()->getCheckSuite('KnpLabs', 'php-github-api', $checkSuiteId);

Rerequest a check suite

https://docs.github.com/en/rest/reference/checks#rerequest-a-check-suite

$annotations = $client->api('repo')->checkSuites()->rerequest('KnpLabs', 'php-github-api', $checkSuiteId);

List check suites for a Git reference

https://docs.github.com/en/rest/reference/checks#list-check-suites-for-a-git-reference

$params = [/*...*/];
$checks = $client->api('repo')->checkSuites()->allForReference('KnpLabs', 'php-github-api', $reference, $params);