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

APIs.io Engineering Platform Checks API

Rich interactions with checks run by your integrations.

APIs.io Engineering Platform Checks API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 12 operations across 11 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}/api/v3.

12 operations 11 paths 15 schemas 6 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://{bucketname}.s3.amazonaws.com
Contact
License
Terms of Service
Resource Areas
1

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.

POST
/repos/{owner}/{repo}/check-runs
APIs.io Engineering Platform Create a check run
checks/create 2 params body → 201
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}
APIs.io Engineering Platform Get a check run
checks/get 3 params → 200
PATCH
/repos/{owner}/{repo}/check-runs/{check_run_id}
APIs.io Engineering Platform Update a check run
checks/update 3 params body → 200
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
APIs.io Engineering Platform List check run annotations
checks/list-annotations 5 params → 200
POST
/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
APIs.io Engineering Platform Rerequest a check run
checks/rerequest-run 3 params → 201403422404
POST
/repos/{owner}/{repo}/check-suites
APIs.io Engineering Platform Create a check suite
checks/create-suite 2 params body → 200201
PATCH
/repos/{owner}/{repo}/check-suites/preferences
APIs.io Engineering Platform Update repository preferences for check suites
checks/set-suites-preferences 2 params body → 200
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}
APIs.io Engineering Platform Get a check suite
checks/get-suite 3 params → 200
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
APIs.io Engineering Platform List check runs in a check suite
checks/list-for-suite 8 params → 200
POST
/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
APIs.io Engineering Platform Rerequest a check suite
checks/rerequest-suite 3 params → 201
GET
/repos/{owner}/{repo}/commits/{ref}/check-runs
APIs.io Engineering Platform List check runs for a Git reference
checks/list-for-ref 9 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-ref 7 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), simple-user (21 properties), nullable-simple-user (21 properties), check-suite (19 properties). Each schema is shown below with its type and property counts.

check-annotation
object
Check Annotation
10 properties 10 required
simple-commit
object
A commit.
6 properties 6 required
minimal-repository
object
Minimal Repository
87 properties 46 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
check-suite
object
A suite of checks performed on the code of a given code change
19 properties 17 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
pull-request-minimal
object
5 properties 5 required
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
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
check-run
object
A check performed on the code of a given code change
17 properties 16 required
check-suite-preference
object
Check suite configuration preferences for a repository.
2 properties 2 required
simple-user
object
A GitHub user.
21 properties 18 required
security-and-analysis
objectnull
3 properties
empty-object
object
An object without any properties.
basic-error
object
Basic Error
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-checks-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform 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.