View Source GitHub.CodeScanning (GitHub REST API Client v0.2.3)
Provides API endpoints related to code scanning
Link to this section Summary
Functions
Delete a code scanning analysis from a repository
Get a code scanning alert
Get a code scanning analysis for a repository
Get a CodeQL database for a repository
Get a code scanning default setup configuration
Get information about a SARIF upload
List instances of a code scanning alert
List code scanning alerts for an organization
List code scanning alerts for a repository
List CodeQL databases for a repository
List code scanning analyses for a repository
Update a code scanning alert
Update a code scanning default setup configuration
Upload an analysis as SARIF data
Link to this section Functions
@spec delete_analysis(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.CodeScanning.AnalysisDeletion.t()} | {:error, GitHub.Error.t()}
Delete a code scanning analysis from a repository
Deletes a specified code scanning analysis from a repository. For
private repositories, you must use an access token with the repo
scope. For public repositories,
you must use an access token with public_repo
scope.
GitHub Apps must have the security_events
write permission to use this endpoint.
You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. Conceptually, the process is similar to the undo function in a text editor.
When you list the analyses for a repository, one or more will be identified as deletable in the response:
"deletable": true
An analysis is deletable when it's the most recent in a set of analyses. Typically, a repository will have multiple sets of analyses for each enabled code scanning tool, where a set is determined by a unique combination of analysis values:
ref
tool
category
If you attempt to delete an analysis that is not the most recent in a set, you'll get a 400 response with the message:
Analysis specified is not deletable.
The response from a successful DELETE
operation provides you with
two alternative URLs for deleting the next analysis in the set:
next_analysis_url
and confirm_delete_url
.
Use the next_analysis_url
URL if you want to avoid accidentally deleting the final analysis
in a set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the confirm_delete_url
URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set, the value of next_analysis_url
and confirm_delete_url
in the 200 response is null
.
As an example of the deletion process, let's imagine that you added a workflow that configured a particular code scanning tool to analyze the code in a repository. This tool has added 15 analyses: 10 on the default branch, and another 5 on a topic branch. You therefore have two separate sets of analyses for this tool. You've now decided that you want to remove all of the analyses for the tool. To do this you must make 15 separate deletion requests. To start, you must find an analysis that's identified as deletable. Each set of analyses always has one that's identified as deletable. Having found the deletable analysis for one of the two sets, delete this analysis and then continue deleting the next analysis in the set until they're all deleted. Then repeat the process for the second set. The procedure therefore consists of a nested loop:
Outer loop:
- List the analyses for the repository, filtered by tool.
- Parse this list to find a deletable analysis. If found:Inner loop:
- Delete the identified analysis.
- Parse the response for the value of
confirm_delete_url
and, if found, use this in the next iteration.
The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url
value. Alternatively, you could use the next_analysis_url
value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
options
Options
confirm_delete
: Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter totrue
, you'll get a 400 response with the message:Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.
resources
Resources
@spec get_alert(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.CodeScanning.Alert.t()} | {:error, GitHub.Error.t()}
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 with private repos, the public_repo
scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events
read permission to use this endpoint.
resources
Resources
@spec get_analysis(String.t(), String.t(), integer(), keyword()) :: {:ok, map() | GitHub.CodeScanning.Analysis.t()} | {:error, GitHub.Error.t()}
Get a code scanning analysis for a repository
Gets a specified code scanning analysis for a repository.
You must use an access token with the security_events
scope to use this endpoint with private repos,
the public_repo
scope also grants permission to read security events on public repos only.
GitHub Apps must have the security_events
read permission to use this endpoint.
The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, the datetime of the analysis, the name of the code scanning tool, and the number of alerts.
The rules_count
field in the default 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.
If you use the Accept header application/sarif+json
,
the response contains the analysis data that was uploaded.
This is formatted as
SARIF version 2.1.0.
resources
Resources
@spec get_codeql_database(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.CodeScanning.CodeqlDatabase.t()} | {:error, GitHub.Error.t()}
Get a CodeQL database for a repository
Gets a CodeQL database for a language in a repository.
By default this endpoint returns JSON metadata about the CodeQL database. To
download the CodeQL database binary content, set the Accept
header of the request
to application/zip
, and make sure
your HTTP client is configured to follow redirects or use the Location
header
to make a second request to get the redirect URL.
For private repositories, you must use an access token with the security_events
scope.
For public repositories, you can use tokens with the security_events
or public_repo
scope.
GitHub Apps must have the contents
read permission to use this endpoint.
resources
Resources
@spec get_default_setup(String.t(), String.t(), keyword()) :: {:ok, GitHub.CodeScanning.DefaultSetup.t()} | {:error, GitHub.Error.t()}
Get a code scanning default setup configuration
Gets a code scanning default setup configuration.
You must use an access token with the repo
scope to use this endpoint with private repos or the public_repo
scope for public repos. GitHub Apps must have the repo
write permission to use this endpoint.
resources
Resources
@spec get_sarif(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.CodeScanning.SarifsStatus.t()} | {:error, GitHub.Error.t()}
Get information about a SARIF upload
Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "Get a code scanning analysis for a repository." You must use an access token with the security_events
scope to use this endpoint with private repos, the public_repo
scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events
read permission to use this endpoint.
resources
Resources
@spec list_alert_instances(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.CodeScanning.AlertInstance.t()]} | {:error, GitHub.Error.t()}
List instances of a code scanning alert
Lists all instances of the specified code scanning alert.
You must use an access token with the security_events
scope to use this endpoint with private repos,
the public_repo
scope also grants permission to read security events on public repos only.
GitHub Apps must have the security_events
read permission to use this endpoint.
options
Options
page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).ref
: The Git reference for the results you want to list. Theref
for a branch can be formatted either asrefs/heads/<branch name>
or simply<branch name>
. To reference a pull request userefs/pull/<number>/merge
.
resources
Resources
@spec list_alerts_for_org( String.t(), keyword() ) :: {:ok, [GitHub.CodeScanning.OrganizationAlertItems.t()]} | {:error, GitHub.Error.t()}
List code scanning alerts for an organization
Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "Managing security managers in your organization."
To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo
scope or security_events
scope.
For public repositories, you may instead use the public_repo
scope.
GitHub Apps must have the security_events
read permission to use this endpoint.
options
Options
tool_name
: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using eithertool_name
ortool_guid
, but not both.tool_guid
: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using eithertool_guid
ortool_name
, but not both.before
: A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.after
: A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).direction
: The direction to sort the results by.state
: If specified, only code scanning alerts with this state will be returned.sort
: The property by which to sort the results.severity
: If specified, only code scanning alerts with this severity will be returned.
resources
Resources
@spec list_alerts_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.CodeScanning.AlertItems.t()]} | {:error, GitHub.Error.t()}
List code scanning alerts for a repository
Lists code scanning alerts.
To use this endpoint, you must use an access token with the security_events
scope or, for alerts from public repositories only, an access token with the public_repo
scope.
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).
options
Options
tool_name
: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using eithertool_name
ortool_guid
, but not both.tool_guid
: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using eithertool_guid
ortool_name
, but not both.page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).ref
: The Git reference for the results you want to list. Theref
for a branch can be formatted either asrefs/heads/<branch name>
or simply<branch name>
. To reference a pull request userefs/pull/<number>/merge
.direction
: The direction to sort the results by.sort
: The property by which to sort the results.state
: If specified, only code scanning alerts with this state will be returned.severity
: If specified, only code scanning alerts with this severity will be returned.
resources
Resources
@spec list_codeql_databases(String.t(), String.t(), keyword()) :: {:ok, [GitHub.CodeScanning.CodeqlDatabase.t()]} | {:error, GitHub.Error.t()}
List CodeQL databases for a repository
Lists the CodeQL databases that are available in a repository.
For private repositories, you must use an access token with the security_events
scope.
For public repositories, you can use tokens with the security_events
or public_repo
scope.
GitHub Apps must have the contents
read permission to use this endpoint.
resources
Resources
@spec list_recent_analyses(String.t(), String.t(), keyword()) :: {:ok, [GitHub.CodeScanning.Analysis.t()]} | {:error, GitHub.Error.t()}
List code scanning analyses for a repository
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 with private repos,
the public_repo
scope also grants permission to read security events on public repos only.
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.
options
Options
tool_name
: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using eithertool_name
ortool_guid
, but not both.tool_guid
: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using eithertool_guid
ortool_name
, but not both.page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).ref
: The Git reference for the analyses you want to list. Theref
for a branch can be formatted either asrefs/heads/<branch name>
or simply<branch name>
. To reference a pull request userefs/pull/<number>/merge
.sarif_id
: Filter analyses belonging to the same SARIF upload.direction
: The direction to sort the results by.sort
: The property by which to sort the results.
resources
Resources
@spec update_alert(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.CodeScanning.Alert.t()} | {:error, GitHub.Error.t()}
Update a code scanning alert
Updates the status of a single code scanning alert. You must use an access token with the security_events
scope to use this endpoint with private repositories. You can also use tokens with the public_repo
scope for public repositories only. GitHub Apps must have the security_events
write permission to use this endpoint.
resources
Resources
@spec update_default_setup( String.t(), String.t(), GitHub.CodeScanning.DefaultSetupUpdate.t(), keyword() ) :: {:ok, GitHub.CodeScanning.DefaultSetupUpdateResponse.t() | GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
Update a code scanning default setup configuration
Updates a code scanning default setup configuration.
You must use an access token with the repo
scope to use this endpoint with private repos or the public_repo
scope for public repos. GitHub Apps must have the repo
write permission to use this endpoint.
resources
Resources
@spec upload_sarif(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.CodeScanning.SarifsReceipt.t()} | {:error, GitHub.Error.t()}
Upload an analysis as SARIF data
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events
scope to use this endpoint for private repositories. You can also use tokens with the public_repo
scope for public repositories only. GitHub Apps must have the security_events
write permission to use this endpoint. For troubleshooting information, see "Troubleshooting SARIF uploads."
There are two places where you can upload code scanning results.
- If you upload to a pull request, for example
--ref refs/pull/42/merge
or--ref refs/pull/42/head
, then the results appear as alerts in a pull request check. For more information, see "Triaging code scanning alerts in pull requests." - If you upload to a branch, for example
--ref refs/heads/my-branch
, then the results appear in the Security tab for your repository. For more information, see "Managing code scanning alerts for your repository."
You must compress the SARIF-formatted analysis data that you want to upload, using gzip
, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0
SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "SARIF results exceed one or more limits."
SARIF data | Maximum values | Additional limits |
---|---|---|
Runs per file | 20 | |
Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
Rules per run | 25,000 | |
Tool extensions per run | 100 | |
Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
Location per result | 1,000 | Only 100 locations will be included. |
Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted
response includes an id
value.
You can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id}
endpoint.
For more information, see "Get information about a SARIF upload."