Group security settings API

  • Tier: Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
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.
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the group which the authenticated user is a member of
secret_push_protection_enabledbooleanyesWhether secret push protection is enabled for the group.
projects_to_excludearray of integersnoThe IDs of projects to exclude from the feature.
curl --header PUT "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/7/security_settings?secret_push_protection_enabled=true&projects_to_exclude=1,2,3"

Example response:

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