Create a check run - GitHub v3 REST API

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.

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.

curl --location --request POST 'https://api.github.com/repos///check-runs' \ --header 'Content-Type: application/json' \ --data-raw '{ "actions": [ { "description": "Allow us to fix these errors for you", "identifier": "fix_errors", "label": "Fix" } ], "completed_at": "2017-11-30T19:49:10.000Z", "conclusion": "success", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "name": "mighty_readme", "output": { "annotations": [ { "annotation_level": "warning", "end_line": 2, "message": "Check your spelling for '\''banaas'\''.", "path": "README.md", "raw_details": "Do you mean '\''bananas'\'' or '\''banana'\''?", "start_line": 2, "title": "Spell Checker" }, { "annotation_level": "warning", "end_line": 4, "message": "Check your spelling for '\''aples'\''", "path": "README.md", "raw_details": "Do you mean '\''apples'\'' or '\''Naples'\''", "start_line": 4, "title": "Spell Checker" } ], "images": [ { "alt": "Super bananas", "image_url": "http://example.com/images/42" } ], "summary": "There are 0 failures, 2 warnings, and 1 notices.", "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" }, "started_at": "2017-11-30T19:39:10.000Z", "status": "completed" }'

{ "app": { "client_id": "\"Iv1.25b5d1e65ffc4022\"", "client_secret": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"", "created_at": "2017-07-08T20:18:44.000Z", "description": "The description of the app.", "events": [ "label", "deployment" ], "external_url": "https://example.com", "html_url": "https://github.com/apps/super-ci", "id": 37, "installations_count": 5, "name": "Probot Owners", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "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/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "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/users/octocat" }, "pem": "\"-----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": { "deployments": "write", "issues": "read" }, "slug": "probot-owners", "updated_at": "2017-07-08T20:18:44.000Z", "webhook_secret": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" }, "check_suite": { "id": 0 }, "completed_at": "2018-05-04T01:14:52.000Z", "conclusion": "neutral", "deployment": { "created_at": "2012-07-20T01:19:13.000Z", "description": "Deploy request from hubot", "environment": "production", "id": 42, "node_id": "MDEwOkRlcGxveW1lbnQx", "original_environment": "staging", "performed_via_github_app": { "client_id": "\"Iv1.25b5d1e65ffc4022\"", "client_secret": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"", "created_at": "2017-07-08T20:18:44.000Z", "description": "The description of the app.", "events": [ "label", "deployment" ], "external_url": "https://example.com", "html_url": "https://github.com/apps/super-ci", "id": 37, "installations_count": 5, "name": "Probot Owners", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "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/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "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/users/octocat" }, "pem": "\"-----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": { "deployments": "write", "issues": "read" }, "slug": "probot-owners", "updated_at": "2017-07-08T20:18:44.000Z", "webhook_secret": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" }, "production_environment": true, "repository_url": "https://api.github.com/repos/octocat/example", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "task": "deploy", "transient_environment": true, "updated_at": "2012-07-20T01:19:13.000Z", "url": "https://api.github.com/repos/octocat/example/deployments/1" }, "details_url": "https://example.com", "external_id": "42", "head_sha": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", "html_url": "https://github.com/github/hello-world/runs/4", "id": 21, "name": "test-coverage", "node_id": "MDg6Q2hlY2tSdW40", "output": { "annotations_count": 0, "annotations_url": "http://example.com", "summary": "string", "text": "string", "title": "string" }, "pull_requests": [ { "base": { "ref": "string", "repo": { "id": 0, "name": "string", "url": "string" }, "sha": "string" }, "head": { "ref": "string", "repo": { "id": 0, "name": "string", "url": "string" }, "sha": "string" }, "id": 0, "number": 0, "url": "string" } ], "started_at": "2018-05-04T01:14:52.000Z", "status": "queued", "url": "https://api.github.com/repos/github/hello-world/check-runs/4" }

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Body Params application/json

optional

One of

object

actions

array [object {3}]

optional

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. 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."

<= 3 items

completed_at

string <date-time>

optional

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

conclusion

enum<string>

optional

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.

Allowed values:

action_requiredcancelledfailureneutralsuccessskippedstaletimed_out

details_url

string

optional

The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

external_id

string

optional

A reference for the run on the integrator's system.

head_sha

string

required

The SHA of the commit.

name

string

required

The name of the check. For example, "code-coverage".

output

object

optional

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.

started_at

string <date-time>

optional

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

status

enum<string>

required

The current status.

Allowed value:

completed

Default:

queued

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢201Response

application/json

Body

A check performed on the code of a given code change

app

object (GitHub app) | null

required

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-08T20:18:44.000Z

description

string | null

required

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

integer

required

Unique identifier of the GitHub app

Example:

installations_count

integer

optional

The number of installations associated with the GitHub app

Example:

name

string

required

The name of the GitHub app

Example:

Probot Owners

node_id

string

required

Example:

MDExOkludGVncmF0aW9uMQ==

owner

object (Simple User) | null

required

A GitHub user.

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"}

slug

string

optional

The slug name of the GitHub app

Example:

probot-owners

updated_at

string <date-time>

required

Example:

2017-07-08T20:18:44.000Z

webhook_secret

string | null

optional

Example:

"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"

check_suite

object | null

required

integer

required

completed_at

string <date-time> | null

required

Example:

2018-05-04T01:14:52.000Z

conclusion

enum<string> | enum<null>

required

Allowed values:

successfailureneutralcancelledskippedtimed_outaction_required

Example:

neutral

deployment

object (Deployment)

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:13.000Z

description

string | null

required

Example:

Deploy request from hubot

environment

string

required

Name for the target deployment environment.

Example:

production

integer

required

Unique identifier of the deployment

Example:

node_id

string

required

Example:

MDEwOkRlcGxveW1lbnQx

original_environment

string

optional

Example:

staging

performed_via_github_app

object (GitHub app) | null

optional

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:13.000Z

url

string <uri>

required

Example:

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

details_url

string | null

required

Example:

https://example.com

external_id

string | null

required

Example:

head_sha

string

required

The SHA of the commit that is being checked.

Example:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url

string | null

required

Example:

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

integer

required

The id of the check.

Example:

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 | null

required

text

string | null

required

title

string | null

required

pull_requests

array[object (Pull Request Minimal) {5}]

required

base

object

required

head

object

required

integer

required

number

integer

required

url

string

required

started_at

string <date-time> | null

required

Example:

2018-05-04T01:14:52.000Z

status

enum<string>

required

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

Allowed values:

queuedin_progresscompleted

Example:

queued

url

string

required

Example:

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