1
0
mirror of synced 2025-12-22 11:26:57 -05:00
Files
docs/content/rest/reference/code-scanning.md
hubwriter 1105f03181 Enable/disable advanced security via the REST API's repository endpoint (GA) (#19859)
* Add has_advanced_security parameter

* Add temp (locally generated) JSON files

* Add temp (locally generated) JSON files

* Fix 'details' wording mentioned by Marco

* Add temp (locally generated) JSON files

* Add temp (locally generated) JSON files

* Remove locally generated JSON files

* Add locally generated JSON files

* Remove development mode JSON files

* Update OpenAPI Descriptions (#20149)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>

* Update OpenAPI Descriptions (#20151)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>

* Update OpenAPI Descriptions (#20150)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>

Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2021-06-29 12:55:51 +00:00

2.0 KiB

title, redirect_from, product, versions, type, topics, miniTocMaxHeadingLevel
title redirect_from product versions type topics miniTocMaxHeadingLevel
Code scanning
/v3/code-scanning
{% data reusables.gated-features.code-scanning %}
fpt ghes ghae
* >=2.22 *
reference
API
Code scanning
REST
3

{% 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."

{% ifversion fpt or ghes > 3.0 or ghae %}

Custom media type for {% data variables.product.prodname_code_scanning %}

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." {% endif %}

{% include rest_operations_at_current_path %}