GitHub

GitHub Checks API

The GitHub Checks API lets you create and manage check runs and check suites that report detailed status, annotations, and results for commits. It enables CI/CD tools and integrations to report build and test results directly on pull requests with rich output including summaries, text, images, and per-line annotations.

Documentation GitHub

Documentation

📖

Documentation

https://docs.github.com/en/rest/checks

API entry from apis.yml

aid: github:github-checks-api
name: GitHub Checks API
tags:
- Checks
- CI/CD
- Status
baseURL: https://api.github.com
humanURL: https://docs.github.com/en/rest/checks?apiVersion=2022-11-28
properties:
- url: https://docs.github.com/en/rest/checks
  type: Documentation
description: The GitHub Checks API lets you create and manage check runs and check suites that report
  detailed status, annotations, and results for commits. It enables CI/CD tools and integrations to report
  build and test results directly on pull requests with rich output including summaries, text, images,
  and per-line annotations.