check_suite_id parameter
Rerequest a check suite
Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite
webhook event with the action rerequested
. When a check suite is rerequested
, its status
is reset to queued
and the conclusion
is cleared.
To rerequest a check suite, your GitHub App must have the checks:read
permission on a private repository or pull access to a public repository.
Path Parameters
Response
201 application/json
Response
Response
Path Parameters
List check runs for a Git reference
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.
Lists check runs for a commit ref. The ref
can be a SHA, branch name, or a tag name. 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.
Query Parameters
Returns check runs with the specified name
.
Returns check runs with the specified status
. Can be one of queued
, in_progress
, or completed
.
Allowed values:queuedin_progresscompleted
Filters check runs by their completed_at
timestamp. Can be one of latest
(returning the most recent check runs) or all
.
Allowed values:latestall
Default:latest
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
ref parameter
Response
200 application/json
Response
Response
A check performed on the code of a given code change
Show Child Parameters
Path Parameters
Query Parameters
List check suites for a Git reference
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
.
Lists check suites for a commit ref
. The ref
can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read
permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo
scope to get check suites in a private repository.
Query Parameters
Filters check suites by GitHub App id
.
Example:1
Returns check runs with the specified name
.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
ref parameter
Response
200 application/json
Response
Response
A suite of checks performed on the code of a given code change
Show Child Parameters
Path Parameters
Query Parameters
List code scanning alerts for a repository
Lists all open code scanning alerts for the default branch (usually main
or master
). You must use an access token with the security_events
scope to use
this endpoint. GitHub Apps must have the security_events
read permission to use
this endpoint.
The response includes a most_recent_instance
object.
This provides details of the most recent instance of this alert
for the default branch or for the specified Git reference
(if you used ref
in the request).
Query Parameters
The name of the tool used to generate the code scanning analysis.
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
Page number of the results to fetch.
Default:1
Results per page (max 100)
Default:30
The full Git reference, formatted as refs/heads/<branch name>
,
refs/pull/<number>/merge
, or refs/pull/<number>/head
.
State of a code scanning alert.
Allowed values:opencloseddismissedfixed
Path Parameters
Response
application/json
Response
Response
The security alert number.
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
The REST API URL of the alert resource.
The GitHub URL of the alert resource.
The REST API URL for fetching the list of instances for an alert.
State of a code scanning alert.
Allowed values:opencloseddismissedfixed
Simple User
Show Child Parameters
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive
, won't fix
, and used in tests
.
Allowed values:false positivewon't fixused in tests
Show Child Parameters
Show Child Parameters
Show Child Parameters
Path Parameters
Query Parameters
Get a code scanning alert
Gets a single code scanning alert. You must use an access token with the security_events
scope to use this endpoint. GitHub Apps must have the security_events
read permission to use this endpoint.
Deprecation notice:
The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url
.
Path Parameters
The security alert number.
Response
application/json
Response
Response
code-scanning-alert
The security alert number.
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
The REST API URL of the alert resource.
The GitHub URL of the alert resource.
The REST API URL for fetching the list of instances for an alert.
State of a code scanning alert.
Allowed values:opencloseddismissedfixed
Simple User
Show Child Parameters
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive
, won't fix
, and used in tests
.
Allowed values:false positivewon't fixused in tests