| title | Code Scanning | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| intro | The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. | ||||||||
| versions |
|
||||||||
| topics |
|
||||||||
| miniTocMaxHeadingLevel | 3 | ||||||||
| redirect_from |
|
{% data reusables.code-scanning.beta %}
The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "Finding security vulnerabilities and errors in your code."
There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API.
application/sarif+json
You can use this with GET requests sent to the /analyses/{analysis_id} endpoint. For more information about this operation, see "Get a {% data variables.product.prodname_code_scanning %} analysis for a repository." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the github/alertNumber and github/alertUrl properties. The data is formatted as SARIF version 2.1.0.
For more information, see "Media types."