Checks
Download SpecRich interactions with checks run by your integrations.
Create 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.
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.
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.
name
string
required
The name of the check. For example, "code-coverage".
head_sha
string
required
The SHA of the commit.
details_url
string
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
A reference for the run on the integrator's system.
status
string
The current status.
- Default
- "queued"
- Enum
-
- queued
- in_progress
- completed
started_at
string
date-time
The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
conclusion
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.
- Enum
-
- action_required
- cancelled
- failure
- neutral
- success
- skipped
- stale
- timed_out
completed_at
string
date-time
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
output
object (output)
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.
title
string
required
The title of the check run.
summary
string
required
The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
- Max Length
- 65535
text
string
The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
- Max Length
- 65535
annotations
array[object]
Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "About status checks".
object
path
string
required
The path of the file to add an annotation to. For example, assets/css/main.css
.
start_line
int
required
The start line of the annotation. Line numbers start at 1.
end_line
int
required
The end line of the annotation.
start_column
int
The start column of the annotation. Annotations only support start_column
and end_column
on the same line. Omit this parameter if start_line
and end_line
have different values. Column numbers start at 1.
end_column
int
The end column of the annotation. Annotations only support start_column
and end_column
on the same line. Omit this parameter if start_line
and end_line
have different values.
annotation_level
string
required
The level of the annotation.
- Enum
-
- notice
- warning
- failure
message
string
required
A short description of the feedback for these lines of code. The maximum size is 64 KB.
title
string
The title that represents the annotation. The maximum size is 255 characters.
raw_details
string
Details about this annotation. The maximum size is 64 KB.
images
array[object]
Adds images to the output displayed in the GitHub pull request UI.
object
alt
string
required
The alternative text for the image.
image_url
string
required
The full URL of the image.
caption
string
A short image description.
actions
array[object]
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."
object
label
string
required
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
- Max Length
- 20
description
string
required
A short explanation of what this action would do. The maximum size is 40 characters.
- Max Length
- 40
identifier
string
required
A reference for the action on the integrator's system. The maximum size is 20 characters.
- Max Length
- 20
Request
Response
Response
id
int
required
The id of the check.
- Example
- 21
head_sha
string
required
The SHA of the commit that is being checked.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
node_id
string
required
- Example
- "MDg6Q2hlY2tSdW40"
external_id
string or null
required
- Example
- "42"
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/check-runs/4"
html_url
string or null
required
- Example
- "https://github.com/github/hello-world/runs/4"
details_url
string or null
required
- Example
- "https://example.com"
status
string
required
The phase of the lifecycle that the check is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
- Enum
-
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
- Example
- "neutral"
started_at
string or null
date-time
required
- Example
- "2018-05-04T01:14:52Z"
completed_at
string or null
date-time
required
- Example
- "2018-05-04T01:14:52Z"
output
object (output)
required
title
string or null
required
summary
string or null
required
text
string or null
required
annotations_count
int
required
annotations_url
string
uri
required
name
string
required
The name of the check.
- Example
- "test-coverage"
check_suite
object (check_suite) or null
required
id
int
required
app
object (app) or 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.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
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}"
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"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- 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\""
pull_requests
array[object (Pull Request Minimal)]
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
deployment
object (deployment)
A deployment created as the result of an Actions check run from a workflow that references an environment
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1"
id
int
required
Unique identifier of the deployment
- Example
- 42
node_id
string
required
- Example
- "MDEwOkRlcGxveW1lbnQx"
task
string
required
Parameter to specify a task to execute
- Example
- "deploy"
original_environment
string
- Example
- "staging"
environment
string
required
Name for the target deployment environment.
- Example
- "production"
description
string or null
required
- Example
- "Deploy request from hubot"
created_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
updated_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
statuses_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1/statuses"
repository_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example"
transient_environment
boolean
Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- Example
- true
production_environment
boolean
Specifies if the given environment is one that end-users directly interact with. Default: false.
- Example
- true
performed_via_github_app
object (performed_via_github_app) or null
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.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
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}"
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"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- 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\""
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.
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.
check_run_id
int
required
The unique identifier of the check run.
Response
Response
id
int
required
The id of the check.
- Example
- 21
head_sha
string
required
The SHA of the commit that is being checked.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
node_id
string
required
- Example
- "MDg6Q2hlY2tSdW40"
external_id
string or null
required
- Example
- "42"
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/check-runs/4"
html_url
string or null
required
- Example
- "https://github.com/github/hello-world/runs/4"
details_url
string or null
required
- Example
- "https://example.com"
status
string
required
The phase of the lifecycle that the check is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
- Enum
-
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
- Example
- "neutral"
started_at
string or null
date-time
required
- Example
- "2018-05-04T01:14:52Z"
completed_at
string or null
date-time
required
- Example
- "2018-05-04T01:14:52Z"
output
object (output)
required
title
string or null
required
summary
string or null
required
text
string or null
required
annotations_count
int
required
annotations_url
string
uri
required
name
string
required
The name of the check.
- Example
- "test-coverage"
check_suite
object (check_suite) or null
required
id
int
required
app
object (app) or 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.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
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}"
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"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- 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\""
pull_requests
array[object (Pull Request Minimal)]
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
deployment
object (deployment)
A deployment created as the result of an Actions check run from a workflow that references an environment
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1"
id
int
required
Unique identifier of the deployment
- Example
- 42
node_id
string
required
- Example
- "MDEwOkRlcGxveW1lbnQx"
task
string
required
Parameter to specify a task to execute
- Example
- "deploy"
original_environment
string
- Example
- "staging"
environment
string
required
Name for the target deployment environment.
- Example
- "production"
description
string or null
required
- Example
- "Deploy request from hubot"
created_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
updated_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
statuses_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1/statuses"
repository_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example"
transient_environment
boolean
Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- Example
- true
production_environment
boolean
Specifies if the given environment is one that end-users directly interact with. Default: false.
- Example
- true
performed_via_github_app
object (performed_via_github_app) or null
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.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
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}"
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"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- 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\""
Update 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.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write
permission to edit check runs.
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.
check_run_id
int
required
The unique identifier of the check run.
name
string
The name of the check. For example, "code-coverage".
details_url
string
The URL of the integrator's site that has the full details of the check.
external_id
string
A reference for the run on the integrator's system.
started_at
string
date-time
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
status
string
The current status.
- Enum
-
- queued
- in_progress
- completed
conclusion
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.
- Enum
-
- action_required
- cancelled
- failure
- neutral
- success
- skipped
- stale
- timed_out
completed_at
string
date-time
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
output
object (output)
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.
title
string
Required.
summary
string
required
Can contain Markdown.
- Max Length
- 65535
text
string
Can contain Markdown.
- Max Length
- 65535
annotations
array[object]
Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "About status checks".
object
path
string
required
The path of the file to add an annotation to. For example, assets/css/main.css
.
start_line
int
required
The start line of the annotation. Line numbers start at 1.
end_line
int
required
The end line of the annotation.
start_column
int
The start column of the annotation. Annotations only support start_column
and end_column
on the same line. Omit this parameter if start_line
and end_line
have different values. Column numbers start at 1.
end_column
int
The end column of the annotation. Annotations only support start_column
and end_column
on the same line. Omit this parameter if start_line
and end_line
have different values.
annotation_level
string
required
The level of the annotation.
- Enum
-
- notice
- warning
- failure
message
string
required
A short description of the feedback for these lines of code. The maximum size is 64 KB.
title
string
The title that represents the annotation. The maximum size is 255 characters.
raw_details
string
Details about this annotation. The maximum size is 64 KB.
images
array[object]
Adds images to the output displayed in the GitHub pull request UI.
object
alt
string
required
The alternative text for the image.
image_url
string
required
The full URL of the image.
caption
string
A short image description.
actions
array[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. See the actions
object description. To learn more about check runs and requested actions, see "Check runs and requested actions."
object
label
string
required
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
- Max Length
- 20
description
string
required
A short explanation of what this action would do. The maximum size is 40 characters.
- Max Length
- 40
identifier
string
required
A reference for the action on the integrator's system. The maximum size is 20 characters.
- Max Length
- 20
Request
Response
Response
id
int
required
The id of the check.
- Example
- 21
head_sha
string
required
The SHA of the commit that is being checked.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
node_id
string
required
- Example
- "MDg6Q2hlY2tSdW40"
external_id
string or null
required
- Example
- "42"
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/check-runs/4"
html_url
string or null
required
- Example
- "https://github.com/github/hello-world/runs/4"
details_url
string or null
required
- Example
- "https://example.com"
status
string
required
The phase of the lifecycle that the check is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
- Enum
-
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
- Example
- "neutral"
started_at
string or null
date-time
required
- Example
- "2018-05-04T01:14:52Z"
completed_at
string or null
date-time
required
- Example
- "2018-05-04T01:14:52Z"
output
object (output)
required
title
string or null
required
summary
string or null
required
text
string or null
required
annotations_count
int
required
annotations_url
string
uri
required
name
string
required
The name of the check.
- Example
- "test-coverage"
check_suite
object (check_suite) or null
required
id
int
required
app
object (app) or 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.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
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}"
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"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- 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\""
pull_requests
array[object (Pull Request Minimal)]
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
deployment
object (deployment)
A deployment created as the result of an Actions check run from a workflow that references an environment
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1"
id
int
required
Unique identifier of the deployment
- Example
- 42
node_id
string
required
- Example
- "MDEwOkRlcGxveW1lbnQx"
task
string
required
Parameter to specify a task to execute
- Example
- "deploy"
original_environment
string
- Example
- "staging"
environment
string
required
Name for the target deployment environment.
- Example
- "production"
description
string or null
required
- Example
- "Deploy request from hubot"
created_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
updated_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
statuses_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1/statuses"
repository_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example"
transient_environment
boolean
Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- Example
- true
production_environment
boolean
Specifies if the given environment is one that end-users directly interact with. Default: false.
- Example
- true
performed_via_github_app
object (performed_via_github_app) or null
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.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
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}"
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"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- 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\""
List check run annotations
Lists annotations for a check run using the annotation id
. GitHub Apps must have the checks:read
permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo
scope to get annotations for a check run in a private repository.
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.
check_run_id
int
required
The unique identifier of the check run.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
Response
array[object (Check Annotation)]
Check Annotation
object (Check Annotation)
Check Annotation
path
string
required
- Example
- "README.md"
start_line
int
required
- Example
- 2
end_line
int
required
- Example
- 2
start_column
int or null
required
- Example
- 5
end_column
int or null
required
- Example
- 10
annotation_level
string or null
required
- Example
- "warning"
title
string or null
required
- Example
- "Spell Checker"
message
string or null
required
- Example
- "Check your spelling for 'banaas'."
raw_details
string or null
required
- Example
- "Do you mean 'bananas' or 'banana'?"
blob_href
string
required
Link
string
Rerequest a check run
Triggers 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.
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.
check_run_id
int
required
The unique identifier of the check run.
Response
Response
null
Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App
Validation error if the check run is not rerequestable
Resource not found
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Create a check suite
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 and a null
value for head_branch
.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Update repository preferences for check suites". Your GitHub App must have the checks:write
permission to create check suites.
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.
head_sha
string
required
The sha of the head commit.
Request
Response
Response when the suite already exists