Use the REST API to manage use of security features for your enterprise.
Get code security and analysis features for an enterprise Code samples for "Get code security and analysis features for an enterprise"If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
get/enterprises/{enterprise}/code_security_and_analysis
Copy to clipboard curl request example
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/code_security_and_analysis
Response
Status: 200
{ "advanced_security_enabled_for_new_repositories": true, "dependabot_alerts_enabled_for_new_repositories": true, "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true, "secret_scanning_validity_checks_enabled": true }
Warning
Closing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
The authenticated user must be an administrator of the enterprise to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
Parameters for "Update code security and analysis features for an enterprise" Headers Name, Type, Descriptionaccept
string
Setting to application/vnd.github+json
is recommended.
enterprise
string Required
The slug version of the enterprise name.
Body parameters Name, Type, Descriptionadvanced_security_enabled_for_new_repositories
boolean
Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "About GitHub Advanced Security."
advanced_security_enabled_new_user_namespace_repos
boolean
Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see "About GitHub Advanced Security."
dependabot_alerts_enabled_for_new_repositories
boolean
Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "About Dependabot alerts."
secret_scanning_enabled_for_new_repositories
boolean
Whether secret scanning is automatically enabled for new repositories. For more information, see "About secret scanning."
secret_scanning_push_protection_enabled_for_new_repositories
boolean
Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "Protecting pushes with secret scanning."
secret_scanning_push_protection_custom_link
string or null
The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "Protecting pushes with secret scanning." To disable this functionality, set this field to null
.
secret_scanning_non_provider_patterns_enabled_for_new_repositories
boolean or null
Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise.
HTTP response status codes for "Update code security and analysis features for an enterprise" Status code Description204
Action started
404
Resource not found
422
The action could not be taken due to an in progress enablement, or a policy is preventing enablement
Code samples for "Update code security and analysis features for an enterprise"If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
patch/enterprises/{enterprise}/code_security_and_analysis
Copy to clipboard curl request example
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/code_security_and_analysis \ -d '{"advanced_security_enabled_for_new_repositories":true,"advanced_security_enabled_new_user_namespace_repos":true,"dependabot_alerts_enabled_for_new_repositories":true,"secret_scanning_enabled_for_new_repositories":true,"secret_scanning_push_protection_enabled_for_new_repositories":true,"secret_scanning_push_protection_custom_link":"https://github.com/test-org/test-repo/blob/main/README.md","secret_scanning_non_provider_patterns_enabled_for_new_repositories":true}'
Action started
Enable or disable a security featureWarning
Closing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
Enables or disables the specified security feature for all repositories in an enterprise.
The authenticated user must be an administrator of the enterprise to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
Parameters for "Enable or disable a security feature" Headers Name, Type, Descriptionaccept
string
Setting to application/vnd.github+json
is recommended.
enterprise
string Required
The slug version of the enterprise name.
security_product
string Required
The security feature to enable or disable.
Can be one of: advanced_security
, advanced_security_user_namespace
, dependabot_alerts
, secret_scanning
, secret_scanning_push_protection
, secret_scanning_non_provider_patterns
enablement
string Required
The action to take.
enable_all
means to enable the specified security feature for all repositories in the enterprise. disable_all
means to disable the specified security feature for all repositories in the enterprise.
Can be one of: enable_all
, disable_all
204
Action started
404
Resource not found
422
The action could not be taken due to an in progress enablement, or a policy is preventing enablement
Code samples for "Enable or disable a security feature"If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
post/enterprises/{enterprise}/{security_product}/{enablement}
Copy to clipboard curl request example
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/SECURITY_PRODUCT/ENABLEMENT
Action started
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4