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
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.
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
ref parameter
Response
A suite of checks performed on the code of a given code change
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).
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
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
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
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
.
The security alert number.
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
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
Updates the status of 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
write permission to use this endpoint.
The security alert number.
Sets the state of the code scanning alert. Can be one of open
or dismissed
. You must provide dismissed_reason
when you set the state to dismissed
.
Allowed values:opendismissed
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
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
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
Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the page
and per_page
parameters
to list the analyses you’re interested in.
By default 30 analyses are listed per page.
The rules_count
field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and 0
is returned in this field.
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 tool_name
field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool
field.
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
.
An identifier for the upload.
Example:6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
Response
The full Git reference, formatted as refs/heads/<branch name>
,
refs/pull/<number>/merge
, or refs/pull/<number>/head
.
The SHA of the commit to which the analysis you are uploading relates.
Match pattern:^[0-9a-fA-F]+$
>= 40 characters<= 40 characters
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
Identifies the variable values associated with the environment in which this analysis was performed.
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
Example:error reading field xyz
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
The total number of results in the analysis.
The total number of rules used in the analysis.
Unique identifier for this analysis.
The REST API URL of the analysis resource.
An identifier for the upload.
Example:6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
Warning generated when processing the analysis
Example:123 results were ignored