This API exposes
12 operations
across 11 paths,
and defines 15 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
12 operations11 paths15 schemas6 GET2 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Checks API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 12
Across 11 paths, the API surfaces 12 operations — 6 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Checks 12
Rich interactions with checks run by your integrations.
APIs.io Engineering Platform Rerequest a check suite
checks/rerequest-suite3 params→ 201
GET
/repos/{owner}/{repo}/commits/{ref}/check-runs
APIs.io Engineering Platform List check runs for a Git reference
checks/list-for-ref9 params→ 200
GET
/repos/{owner}/{repo}/commits/{ref}/check-suites
APIs.io Engineering Platform List check suites for a Git reference
checks/list-suites-for-ref7 params→ 200
Schemas 15
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), nullable-simple-user (21 properties), simple-user (21 properties), check-suite (19 properties). Each schema is shown below with its type and property counts.
nullable-simple-user
object
A GitHub user.
21 properties18 required
check-annotation
object
Check Annotation
10 properties10 required
pull-request-minimal
object
5 properties5 required
nullable-integration
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 properties11 required
simple-commit
object
A commit.
6 properties6 required
code-of-conduct
object
Code Of Conduct
5 properties4 required
basic-error
object
Basic Error
4 properties
deployment-simple
object
A deployment created as the result of an Actions check run from a workflow that references an environment
14 properties10 required
check-suite
object
A suite of checks performed on the code of a given code change
19 properties17 required
simple-user
object
A GitHub user.
21 properties18 required
check-suite-preference
object
Check suite configuration preferences for a repository.
2 properties2 required
minimal-repository
object
Minimal Repository
87 properties46 required
empty-object
object
An object without any properties.
check-run
object
A check performed on the code of a given code change
17 properties16 required
security-and-analysis
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
