Create a check run
POST {{baseUrl}}/repos/:owner/:repo/check-runs
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.
Request Body
{"name"=>"<string>", "head_sha"=>"<string>", "details_url"=>"<string>", "external_id"=>"<string>", "status"=>"queued", "started_at"=>"<string>", "conclusion"=>"<string>", "completed_at"=>"<string>", "output"=>{"title"=>"<string>", "summary"=>"<string>", "text"=>"<string>", "annotations"=>[{"path"=>"<string>", "start_line"=>"<integer>", "end_line"=>"<integer>", "annotation_level"=>"<string>", "message"=>"<string>", "start_column"=>"<integer>", "end_column"=>"<integer>", "title"=>"<string>", "raw_details"=>"<string>"}, {"path"=>"<string>", "start_line"=>"<integer>", "end_line"=>"<integer>", "annotation_level"=>"<string>", "message"=>"<string>", "start_column"=>"<integer>", "end_column"=>"<integer>", "title"=>"<string>", "raw_details"=>"<string>"}], "images"=>[{"alt"=>"<string>", "image_url"=>"<string>", "caption"=>"<string>"}, {"alt"=>"<string>", "image_url"=>"<string>", "caption"=>"<string>"}]}, "actions"=>[{"label"=>"<string>", "description"=>"<string>", "identifier"=>"<string>"}, {"label"=>"<string>", "description"=>"<string>", "identifier"=>"<string>"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: Created
{"id":4,"head_sha":"ce587453ced02b1526dfb4cb910479d431683101","node_id":"MDg6Q2hlY2tSdW40","external_id":"42","url":"https://api.github.com/repos/github/hello-world/check-runs/4","html_url":"https://github.com/github/hello-world/runs/4","details_url":"https://example.com","status":"in_progress","conclusion":null,"started_at":"2018-05-04T01:14:52Z","completed_at":null,"output":{"title":"Mighty Readme Report","summary":"","text":"","annotations_count":1,"annotations_url":"https://api.github.com/repos/github/hello-world/check-runs/4/annotations"},"name":"mighty_readme","check_suite":{"id":5},"app":{"id":1,"slug":"octoapp","node_id":"MDExOkludGVncmF0aW9uMQ==","owner":{"login":"github","id":1,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE=","url":"https://api.github.com/orgs/github","repos_url":"https://api.github.com/orgs/github/repos","events_url":"https://api.github.com/orgs/github/events","avatar_url":"https://github.com/images/error/octocat_happy.gif","gravatar_id":"","html_url":"https://github.com/octocat","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}","starred_url":"https://api.github.com/users/octocat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/octocat/subscriptions","organizations_url":"https://api.github.com/users/octocat/orgs","received_events_url":"https://api.github.com/users/octocat/received_events","type":"User","site_admin":true},"name":"Octocat App","description":"","external_url":"https://example.com","html_url":"https://github.com/apps/octoapp","created_at":"2017-07-08T16:18:44-04:00","updated_at":"2017-07-08T16:18:44-04:00","permissions":{"metadata":"read","contents":"read","issues":"write","single_file":"write"},"events":["push","pull_request"]},"pull_requests":[{"url":"https://api.github.com/repos/github/hello-world/pulls/1","id":1934,"number":3956,"head":{"ref":"say-hello","sha":"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390","repo":{"id":526,"url":"https://api.github.com/repos/github/hello-world","name":"hello-world"}},"base":{"ref":"master","sha":"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f","repo":{"id":526,"url":"https://api.github.com/repos/github/hello-world","name":"hello-world"}}}]}