How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Checks API

The Checks API from GitHub — 28 operation(s) for checks.

GitHub Checks API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Checks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 31 operations across 25 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

31 operations 25 paths 37 schemas 2 DELETE19 GET3 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Checks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 31

Across 25 paths, the API surfaces 31 operations — 2 DELETE, 19 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Checks 31
POST
/applications/{client_id}/token
GitHub Checktoken
checktoken 1 param body → 200404422
GET
/gists/{gist_id}/star
GitHub Check Ifgist is Starred
checkIfgistIsStarred 1 param → 204304403404
POST
/repos/{owner}/{repo}/check-runs
GitHub Create a Check Run
checks/create 2 params body → 201
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}
GitHub Get a Check Run
checks/get 3 params → 200
PATCH
/repos/{owner}/{repo}/check-runs/{check_run_id}
GitHub Update a Check Run
checks/update 3 params body → 200
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
GitHub List Check Run Annotations
checks/list-annotations 5 params → 200
POST
/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
GitHub Rerequest a Check Run
checks/rerequest-run 3 params → 201403404422
POST
/repos/{owner}/{repo}/check-suites
GitHub Create a Check Suite
checks/create-suite 2 params body → 200201
PATCH
/repos/{owner}/{repo}/check-suites/preferences
GitHub Update Repository Preferences for Check Suites
checks/set-suites-preferences 2 params body → 200
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}
GitHub Get a Check Suite
checks/get-suite 3 params → 200
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
GitHub List Check Runs in a Check Suite
checks/list-for-suite 8 params → 200
POST
/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
GitHub Rerequest a Check Suite
checks/rerequest-suite 3 params → 201
GET
/repos/{owner}/{repo}/commits/{ref}/check-runs
GitHub List Check Runs for a Git Reference
checks/list-for-ref 9 params → 200
GET
/repos/{owner}/{repo}/commits/{ref}/check-suites
GitHub List Check Suites for a Git Reference
checks/list-suites-for-ref 7 params → 200
GET
/orgs/{org}/members/{username}
GitHub Check Organization Membership for User
checkOrganizationMembershipForUser 2 params → 204302404
GET
/orgs/{org}/public_members/{username}
GitHub Check Public Organization Membership for User
checkPublicOrganizationMembershipForUser 2 params → 204404
GET
/orgs/{org}/teams/{team_slug}/projects/{project_id}
GitHub Check Team Permissions for Project
checkTeamPermissionsForProject 3 params → 200404
GET
/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
GitHub Check Team Permissions for Repository
checkTeamPermissionsForRepository 4 params → 200204404
GET
/teams/{team_id}/projects/{project_id}deprecated
GitHub Check Team Permissions for Project (legacy)
checkTeamPermissionsForProjectLegacy 2 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Get Status Checks Protection
getStatusChecksProtection 6 params → 200404
PATCH
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Update Status Check Protection
updateStatusCheckProtection 6 params body → 200404422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Remove Status Check Protection
removeStatusCheckProtection 6 params → 204
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Get All Status Check Contexts
getAllStatusCheckContexts 6 params → 200404
POST
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Add Status Check Contexts
addStatusCheckContexts 6 params body → 200403404422
PUT
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Set Status Check Contexts
setStatusCheckContexts 6 params body → 200404422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Remove Status Check Contexts
removeStatusCheckContexts 6 params body → 200404422
GET
/repos/{owner}/{repo}/collaborators/{username}
GitHub Check if User is Repository Collaborator
checkIfUserIsRepositoryCollaborator 6 params → 204404
GET
/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}
GitHub Check if User Can Be Assigned to Issue
checkIfUserCanBeAssignedToIssue 7 params → 204404
GET
/repos/{owner}/{repo}/pulls/{pull_number}/merge
GitHub Check if Pull Request Has Been Merged
checkIfPullRequestHasBeenMerged 6 params → 204404
GET
/repos/{owner}/{repo}/vulnerability-alerts
GitHub Check if Vulnerability Alerts Are Enabled for Repository
checkIfVulnerabilityAlertsAreEnabledForRepository 5 params → 204404
GET
/teams/{team_id}/repos/{owner}/{repo}deprecated
GitHub Check Team Permissions for Repository (legacy)
checkTeamPermissionsForRepositoryLegacy 3 params → 200204404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are team-repository (89 properties), minimal-repository (87 properties), minimal-repository_2 (87 properties), app-permissions (45 properties). Each schema is shown below with its type and property counts.

simple-user
object
A GitHub user.
21 properties 18 required
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
nullable-scoped-installation
objectnull
7 properties 5 required
app-permissions
object
The permissions granted to the user access token.
45 properties
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties 13 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
check-suite
object
A suite of checks performed on the code of a given code change
19 properties 17 required
security-and-analysis
objectnull
3 properties
nullable-integration
objectnull
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…
17 properties 11 required
deployment-simple
object
A deployment created as the result of an Actions check run from a workflow that references an environment
14 properties 10 required
simple-commit
object
A commit.
6 properties 6 required
pull-request-minimal
object
5 properties 5 required
empty-object
object
An object without any properties.
check-suite-preference
object
Check suite configuration preferences for a repository.
2 properties 2 required
check-run
object
A check performed on the code of a given code change
17 properties 16 required
check-annotation
object
Check Annotation
10 properties 10 required
team-repository
object
A team's access to a repository.
89 properties 73 required
team-project
object
A team's access to a project.
16 properties 14 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
status-check-policy
object
Status Check Policy
5 properties 5 required
validation-error_2
object
Validation Error
3 properties 2 required
code-of-conduct_2
object
Code Of Conduct
5 properties 4 required
minimal-repository_2
object
Minimal Repository
87 properties 46 required
check-suite_2
object
suite of checks performed on the code of a given code change
19 properties 17 required
security-and-analysis_2
object
3 properties
simple-user_2
object
GitHub user.
21 properties 18 required
nullable-integration_2
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…
17 properties 11 required
deployment-simple_2
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties 10 required
simple-commit_2
object
commit.
6 properties 6 required
pull-request-minimal_2
object
5 properties 5 required
empty-object_2
object
An object without any properties.
check-run_2
object
check performed on the code of a given code change
17 properties 16 required
nullable-simple-user_2
object
GitHub user.
21 properties 18 required
check-annotation_2
object
Check Annotation
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-checks-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Checks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.