PATCH

Try PATCH /repos/{owner}/{repo}/check-runs/{check_run_id} — GitHub API

GitHub playground

Update a check run

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. check_run_id · required · integer The unique identifier of the check run.

Body application/json

9 body fields

name · optional · string — The name of the check. For example, "code-coverage".
details_url · optional · string — The URL of the integrator's site that has the full details of the check.
external_id · optional · string — A reference for the run on the integrator's system.
started_at · optional · string — This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
status · optional · string — The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
conclusion · required · string — **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
completed_at · optional · string — The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
output · optional · object — Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.
actions · optional · object[] — Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)."