Checks

Rich interactions with checks run by your integrations.

Operations

Method	Endpoint	Description
`POST`	`/repos/{owner}/{repo}/check-runs`	Create a check run
`GET`	`/repos/{owner}/{repo}/check-runs/{check_run_id}`	Get a check run
`PATCH`	`/repos/{owner}/{repo}/check-runs/{check_run_id}`	Update a check run
`GET`	`/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations`	List check run annotations
`POST`	`/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest`	Rerequest a check run
`POST`	`/repos/{owner}/{repo}/check-suites`	Create a check suite
`PATCH`	`/repos/{owner}/{repo}/check-suites/preferences`	Update repository preferences for check suites
`GET`	`/repos/{owner}/{repo}/check-suites/{check_suite_id}`	Get a check suite
`GET`	`/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`	List check runs in a check suite
`POST`	`/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest`	Rerequest a check suite
`GET`	`/repos/{owner}/{repo}/commits/{ref}/check-runs`	List check runs for a Git reference
`GET`	`/repos/{owner}/{repo}/commits/{ref}/check-suites`	List check suites for a Git reference

Example

Get a check run, with the TypeScript SDK:

import { GitHubV3REST } from "github";

const client = new GitHubV3REST({
  baseUrl: "https://api.github.com",
});

const result = await client.checks.get({
  owner: "owner",
  repo: "repo",
  checkRunId: 1,
});
console.log(result);

Nine more languages

The same call exists in every SDK. See SDKs for the other nine.