Skip to main content

runs

Overview

Nameruns
TypeResource
Idgithub.checks.runs

Fields

NameDatatypeDescription
idintegerThe id of the check.
namestringThe name of the check.
appobjectGitHub 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 come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
check_suiteobject
completed_atstring
conclusionstring
deploymentobjectA deployment created as the result of an Actions check run from a workflow that references an environment
details_urlstring
external_idstring
head_shastringThe SHA of the commit that is being checked.
html_urlstring
node_idstring
outputobject
pull_requestsarrayPull requests that are open with a head_sha or head_branch that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
started_atstring
statusstringThe phase of the lifecycle that the check is currently in.
urlstring

Methods

NameAccessible byRequired ParamsDescription
getSELECTcheck_run_id, owner, repoNote: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.
list_for_refSELECTowner, ref, repoNote: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.
list_for_suiteSELECTcheck_suite_id, owner, repoNote: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.
createINSERTowner, repo, data__head_sha, data__nameNote: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
rerequest_runEXECcheck_run_id, owner, repoTriggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.

To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

For more information about how to re-run GitHub Actions jobs, see "Re-run a job from a workflow run".
updateEXECcheck_run_id, owner, repoNote: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.