Sample - GitHub REST API
POST/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest

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, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

For more information about how to re-run GitHub Actions jobs, see "Re-run a job from a workflow run".

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
check_run_idintegerrequired
The unique identifier of the check run.

4 status codes
201Response
403Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation error if the check run is not rerequestable
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 403 is returned: Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App. A 404 is returned: Resource not found. A 422 is returned: Validation error if the check run is not rerequestable.