gitlab-foss/doc/api/group_security_settings.md

stage, group, info, title

stage	group	info	title
Security Risk Management	Security Platform Management	To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments	Group security settings API

{{< details >}}

• Tier: Ultimate
• Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Introduced in GitLab 17.7.

{{< /history >}}

Every API call to group security settings must be authenticated.

If a user isn't a member of a private group, requests to the private group return a 404 Not Found status code.

Update secret_push_protection_enabled setting

Update the secret_push_protection_enabled setting for the all projects in a group to the provided value.

Set to true to enable secret push protection for the all projects in the group.

Prerequisites:

• You must have at least the Maintainer role for the group.

Attribute	Type	Required	Description
id	integer or string	yes	The ID or URL-encoded path of the group which the authenticated user is a member of
secret_push_protection_enabled	boolean	yes	Whether secret push protection is enabled for the group.
projects_to_exclude	array of integers	no	The IDs of projects to exclude from the feature.

curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/7/security_settings?secret_push_protection_enabled=true&projects_to_exclude[]=1&projects_to_exclude[]=2"

Example response:

{
  "secret_push_protection_enabled": true,
  "errors": []
}