docs/content/rest/secret-scanning.md

title, intro, versions, topics, miniTocMaxHeadingLevel, redirect_from

title	intro	versions	topics	miniTocMaxHeadingLevel	redirect_from
Secret scanning	Use the Secret scanning API to retrieve and update secret alerts from a repository.	ghes ghae ghec * * *	API	3	/rest/reference/secret-scanning

{% data reusables.secret-scanning.api-beta %}

About the Secret scanning API

The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}:

• Enable or disable {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %} and push protection{% endif %} for a repository. For more information, see "Repositories" and expand the "Properties of the security_and_analysis object" section in the REST API documentation.
• Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below. {%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a repository.{% endif %}

For more information about {% data variables.product.prodname_secret_scanning %}, see "About {% data variables.product.prodname_secret_scanning %}."