sarifs
Overview
| Name | sarifs |
| Type | Resource |
| Id | github.code_scanning.sarifs |
Fields
| Name | Datatype | Description |
|---|---|---|
analyses_url | string | The REST API URL for getting the analyses associated with the upload. |
errors | array | Any errors that ocurred during processing of the delivery. |
processing_status | string | pending files have not yet been processed, while complete means results from the SARIF have been stored. failed files have either not been processed at all, or could only be partially processed. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_sarif | SELECT | owner, repo, sarif_id | 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. |
upload_sarif | EXEC | owner, repo, data__commit_sha, data__ref, data__sarif | 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:<br />gzip -c analysis-data.sarif \| base64 -w0<br /><br> 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." |