Get a check run

**Note:** 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.

GET/repos/{owner}/{repo}/check-runs/{check_run_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required
check_run_id integer required: check_run_id parameter

Responses

application/json CheckRun object

Response

app GitHub app object

requirednullable

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 come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

client_id string

optional

Example: "Iv1.25b5d1e65ffc4022"

client_secret string

optional

Example: "1d4b2097ac622ba702d19de498f005747a8b21d3"

created_at string<date-time>

required

Example: 2017-07-08T16:18:44-04:00

description string

requirednullable

Example: The description of the app.

events array[string]

required

The list of events for the GitHub app

Example:

[
  "label",
  "deployment"
]

external_url string<uri>

required

Example: https://example.com

html_url string<uri>

required

Example: https://github.com/apps/super-ci

id integer

required

Unique identifier of the GitHub app

Example: 37

installations_count integer

optional

The number of installations associated with the GitHub app

Example: 5

name string

required

The name of the GitHub app

Example: Probot Owners

node_id string

required

Example: MDExOkludGVncmF0aW9uMQ==

owner Simple User object

requirednullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

pem string

optional

Example:

"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"

permissions object

required

The set of permissions for the GitHub app

Example:

{
  "deployments": "write",
  "issues": "read"
}

checks string

optional

contents string

optional

deployments string

optional

issues string

optional

metadata string

optional

slug string

optional

The slug name of the GitHub app

Example: probot-owners

updated_at string<date-time>

required

Example: 2017-07-08T16:18:44-04:00

webhook_secret string

optionalnullable

Example: "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"

check_suite object

requirednullable

id integer

required

completed_at string<date-time>

requirednullable

Example: 2018-05-04T01:14:52Z

conclusion string

requirednullable

Example: neutral

Allowed: "success""failure""neutral""cancelled""skipped""timed_out""action_required"

deployment Deployment object

optional

A deployment created as the result of an Actions check run from a workflow that references an environment

created_at string<date-time>

required

Example: 2012-07-20T01:19:13Z

description string

requirednullable

Example: Deploy request from hubot

environment string

required

Name for the target deployment environment.

Example: production

id integer

required

Unique identifier of the deployment

Example: 42

node_id string

required

Example: MDEwOkRlcGxveW1lbnQx

original_environment string

optional

Example: staging

performed_via_github_app GitHub app object

optionalnullable

client_id string

optional

Example: "Iv1.25b5d1e65ffc4022"

client_secret string

optional

Example: "1d4b2097ac622ba702d19de498f005747a8b21d3"

created_at string<date-time>

required

Example: 2017-07-08T16:18:44-04:00

description string

requirednullable

Example: The description of the app.

events array[string]

required

The list of events for the GitHub app

Example:

[
  "label",
  "deployment"
]

external_url string<uri>

required

Example: https://example.com

html_url string<uri>

required

Example: https://github.com/apps/super-ci

id integer

required

Unique identifier of the GitHub app

Example: 37

installations_count integer

optional

The number of installations associated with the GitHub app

Example: 5

name string

required

The name of the GitHub app

Example: Probot Owners

node_id string

required

Example: MDExOkludGVncmF0aW9uMQ==

owner Simple User object

requirednullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

pem string

optional

Example:

"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"

permissions object

required

The set of permissions for the GitHub app

Example:

{
  "deployments": "write",
  "issues": "read"
}

checks string

optional

contents string

optional

deployments string

optional

issues string

optional

metadata string

optional

slug string

optional

The slug name of the GitHub app

Example: probot-owners

updated_at string<date-time>

required

Example: 2017-07-08T16:18:44-04:00

webhook_secret string

optionalnullable

Example: "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"

production_environment boolean

optional

Specifies if the given environment is one that end-users directly interact with. Default: false.

Example: true

repository_url string<uri>

required

Example: https://api.github.com/repos/octocat/example

statuses_url string<uri>

required

Example: https://api.github.com/repos/octocat/example/deployments/1/statuses

task string

required

Parameter to specify a task to execute

Example: deploy

transient_environment boolean

optional

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

Example: true

updated_at string<date-time>

required

Example: 2012-07-20T01:19:13Z

url string<uri>

required

Example: https://api.github.com/repos/octocat/example/deployments/1

details_url string

requirednullable

Example: https://example.com

external_id string

requirednullable

Example: 42

head_sha string

required

The SHA of the commit that is being checked.

Example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url string

requirednullable

Example: https://github.com/github/hello-world/runs/4

id integer

required

The id of the check.

Example: 21

name string

required

The name of the check.

Example: test-coverage

node_id string

required

Example: MDg6Q2hlY2tSdW40

output object

required

annotations_count integer

required

annotations_url string<uri>

required

summary string

requirednullable

text string

requirednullable

title string

requirednullable

pull_requests array[Pull Request Minimal object]

required

items Pull Request Minimal object

base object

required

ref string

required

repo object

required

sha string

required

head object

required

ref string

required

repo object

required

sha string

required

id integer

required

number integer

required

url string

required

started_at string<date-time>

requirednullable

Example: 2018-05-04T01:14:52Z

status string

required

The phase of the lifecycle that the check is currently in.

Example: queued

Allowed: "queued""in_progress""completed"

url string

required

Example: https://api.github.com/repos/github/hello-world/check-runs/4

Response Example: 200 application/json

{
  "app": {
    "created_at": "2017-07-08T16:18:44-04:00",
    "description": "",
    "events": [
      "push",
      "pull_request"
    ],
    "external_url": "https://example.com",
    "html_url": "https://github.com/apps/octoapp",
    "id": 1,
    "name": "Octocat App",
    "node_id": "MDExOkludGVncmF0aW9uMQ==",
    "owner": {
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "events_url": "https://api.github.com/orgs/github/events",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "gravatar_id": "",
      "html_url": "https://github.com/octocat",
      "id": 1,
      "login": "github",
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "repos_url": "https://api.github.com/orgs/github/repos",
      "site_admin": true,
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "type": "User",
      "url": "https://api.github.com/orgs/github"
    },
    "permissions": {
      "contents": "read",
      "issues": "write",
      "metadata": "read",
      "single_file": "write"
    },
    "slug": "octoapp",
    "updated_at": "2017-07-08T16:18:44-04:00"
  },
  "check_suite": {
    "id": 5
  },
  "completed_at": "2018-05-04T01:14:52Z",
  "conclusion": "neutral",
  "details_url": "https://example.com",
  "external_id": "",
  "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
  "html_url": "https://github.com/github/hello-world/runs/4",
  "id": 4,
  "name": "mighty_readme",
  "node_id": "MDg6Q2hlY2tSdW40",
  "output": {
    "annotations_count": 2,
    "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations",
    "summary": "There are 0 failures, 2 warnings, and 1 notice.",
    "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
    "title": "Mighty Readme report"
  },
  "pull_requests": [
    {
      "base": {
        "ref": "master",
        "repo": {
          "id": 526,
          "name": "hello-world",
          "url": "https://api.github.com/repos/github/hello-world"
        },
        "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f"
      },
      "head": {
        "ref": "say-hello",
        "repo": {
          "id": 526,
          "name": "hello-world",
          "url": "https://api.github.com/repos/github/hello-world"
        },
        "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390"
      },
      "id": 1934,
      "number": 3956,
      "url": "https://api.github.com/repos/github/hello-world/pulls/1"
    }
  ],
  "started_at": "2018-05-04T01:14:52Z",
  "status": "completed",
  "url": "https://api.github.com/repos/github/hello-world/check-runs/4"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

check_run_id *

check_run_id parameter

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/check-runs/{check_run_id}