[Skip to main content](https://docs.gitlab.com/api/protected_branches/#skipTarget) [Go to GitLab Docs homepage](https://docs.gitlab.com/)
`/`
[What's new?](https://about.gitlab.com/releases/whats-new/)
English
  * Language
  * English
  * 日本語


v18.10
  *     * [18.10 (not yet released)](https://docs.gitlab.com/api/protected_branches/)
  *     * [18.9 (recently released)](https://docs.gitlab.com/18.9/api/protected_branches/)
    * [18.8](https://docs.gitlab.com/18.8/api/protected_branches/)
    * [18.7](https://archives.docs.gitlab.com/18.7/api/protected_branches/)
  *     * [17.11](https://archives.docs.gitlab.com/17.11/api/protected_branches/)
    * [16.11](https://archives.docs.gitlab.com/16.11/ee/api/protected_branches.html)
  *     * [Archives](https://docs.gitlab.com/archives)


Select theme and layout
  * Light mode
  * Dark mode
  * Auto


  * Fixed width
  * Fluid width


[What's new?](https://about.gitlab.com/releases/whats-new/) [Get free trial](https://gitlab.com/-/trial_registrations/new?glm_source=docs.gitlab.com&amp;glm_content=navigation-cta-docs)
Toggle menu
  * [Use GitLab](https://docs.gitlab.com/user/)
  * [GitLab Duo](https://docs.gitlab.com/user/gitlab_duo/)
  * [Extend](https://docs.gitlab.com/api/)
  * [Install](https://docs.gitlab.com/install/)
  * [Administer](https://docs.gitlab.com/administration/)
  * [Subscribe](https://docs.gitlab.com/subscriptions/)
  * [Contribute](https://docs.gitlab.com/development/)
  * [Solutions](https://docs.gitlab.com/solutions/)


Select a topicUse GitLab GitLab Duo Extend Install Administer Subscribe Contribute Solutions
[Getting started](https://docs.gitlab.com/api/get_started/get_started_extending/)
[Tutorials](https://docs.gitlab.com/tutorials/develop/)
[Integrations](https://docs.gitlab.com/integration/)
[Webhooks](https://docs.gitlab.com/user/project/integrations/webhooks/)
[REST API](https://docs.gitlab.com/api/rest/)
[Resources](https://docs.gitlab.com/api/api_resources/)
[.gitignore (templates)](https://docs.gitlab.com/api/templates/gitignores/)
[.gitlab-ci.yml (templates)](https://docs.gitlab.com/api/templates/gitlab_ci_ymls/)
[Access requests](https://docs.gitlab.com/api/access_requests/)
[Agent for Kubernetes](https://docs.gitlab.com/api/cluster_agents/)
[AI Catalog admin](https://docs.gitlab.com/api/admin/ai_catalog/)
[Alert management](https://docs.gitlab.com/api/alert_management_alerts/)
[Application appearance](https://docs.gitlab.com/api/appearance/)
[Application settings](https://docs.gitlab.com/api/settings/)
[Application statistics](https://docs.gitlab.com/api/statistics/)
[Applications](https://docs.gitlab.com/api/applications/)
[Attestations](https://docs.gitlab.com/api/attestations/)
[Audit events](https://docs.gitlab.com/api/audit_events/)
[Avatar](https://docs.gitlab.com/api/avatar/)
[Branches](https://docs.gitlab.com/api/branches/)
[Broadcast messages](https://docs.gitlab.com/api/broadcast_messages/)
[Cluster discovery (certificate-based) (deprecated)](https://docs.gitlab.com/api/cluster_discovery/)
[Code Suggestions](https://docs.gitlab.com/api/code_suggestions/)
[Commits](https://docs.gitlab.com/api/commits/)
[Compliance and policy settings](https://docs.gitlab.com/api/compliance_policy_settings/)
[Composer](https://docs.gitlab.com/api/packages/composer/)
[Conan v1](https://docs.gitlab.com/api/packages/conan_v1/)
[Conan v2](https://docs.gitlab.com/api/packages/conan_v2/)
[Container registry](https://docs.gitlab.com/api/container_registry/)
[Container repository protection rules](https://docs.gitlab.com/api/container_repository_protection_rules/)
[Container registry protection tag rules](https://docs.gitlab.com/api/container_registry_protection_tag_rules/)
[Container virtual registry](https://docs.gitlab.com/api/container_virtual_registries/)
[Custom attributes](https://docs.gitlab.com/api/custom_attributes/)
[Database migrations](https://docs.gitlab.com/api/database_migrations/)
[Data management](https://docs.gitlab.com/api/admin/data_management/)
[Debian](https://docs.gitlab.com/api/packages/debian/)
[Debian group distributions](https://docs.gitlab.com/api/packages/debian_group_distributions/)
[Debian project distributions](https://docs.gitlab.com/api/packages/debian_project_distributions/)
[Dependencies](https://docs.gitlab.com/api/dependencies/)
[Dependency list export](https://docs.gitlab.com/api/dependency_list_export/)
[Dependency Proxy](https://docs.gitlab.com/api/dependency_proxy/)
[Deploy keys](https://docs.gitlab.com/api/deploy_keys/)
[Deploy tokens](https://docs.gitlab.com/api/deploy_tokens/)
[Deployments](https://docs.gitlab.com/api/deployments/)
[Discussions](https://docs.gitlab.com/api/discussions/)
[Dockerfile (templates)](https://docs.gitlab.com/api/templates/dockerfiles/)
[DORA4 metrics](https://docs.gitlab.com/api/dora/metrics/)
[Emoji reactions](https://docs.gitlab.com/api/emoji_reactions/)
[Environments](https://docs.gitlab.com/api/environments/)
[Epics (deprecated)](https://docs.gitlab.com/api/epics/)
[Error tracking](https://docs.gitlab.com/api/error_tracking/)
[Events](https://docs.gitlab.com/api/events/)
[Experiments](https://docs.gitlab.com/api/experiments/)
[External status checks](https://docs.gitlab.com/api/status_checks/)
[Feature flags](https://docs.gitlab.com/api/feature_flags/)
[Feature flag user lists](https://docs.gitlab.com/api/feature_flag_user_lists/)
[Freeze periods](https://docs.gitlab.com/api/freeze_periods/)
[Geo nodes (deprecated)](https://docs.gitlab.com/api/geo_nodes/)
[Geo sites](https://docs.gitlab.com/api/geo_sites/)
[GitLab Duo Chat completions](https://docs.gitlab.com/api/chat/)
[GitLab Pages](https://docs.gitlab.com/api/pages/)
[GLQL](https://docs.gitlab.com/api/glql/)
[Go Proxy](https://docs.gitlab.com/api/packages/go_proxy/)
[Google Cloud integration](https://docs.gitlab.com/api/google_cloud_integration/)
[Groups](https://docs.gitlab.com/api/groups/)
[Helm](https://docs.gitlab.com/api/packages/helm/)
[Import](https://docs.gitlab.com/api/import/)
[Instance CI/CD variables](https://docs.gitlab.com/api/instance_level_ci_variables/)
[Invitations](https://docs.gitlab.com/api/invitations/)
[Issues](https://docs.gitlab.com/api/issues/)
[Issues (epic) (deprecated)](https://docs.gitlab.com/api/epic_issues/)
[Issues statistics](https://docs.gitlab.com/api/issues_statistics/)
[Jobs](https://docs.gitlab.com/api/jobs/)
[Job artifacts](https://docs.gitlab.com/api/job_artifacts/)
[Job token scopes](https://docs.gitlab.com/api/project_job_token_scopes/)
[Keys](https://docs.gitlab.com/api/keys/)
[License](https://docs.gitlab.com/api/license/)
[Licenses (templates)](https://docs.gitlab.com/api/templates/licenses/)
[Linked epics (deprecated)](https://docs.gitlab.com/api/linked_epics/)
[Links (issue)](https://docs.gitlab.com/api/issue_links/)
[Links (epic) (deprecated)](https://docs.gitlab.com/api/epic_links/)
[Lint .gitlab-ci.yml](https://docs.gitlab.com/api/lint/)
[Markdown](https://docs.gitlab.com/api/markdown/)
[Maven](https://docs.gitlab.com/api/packages/maven/)
[Maven virtual registry](https://docs.gitlab.com/api/maven_virtual_registries/)
[Member roles](https://docs.gitlab.com/api/member_roles/)
[Merge request approvals](https://docs.gitlab.com/api/merge_request_approvals/)
[Merge request approval settings](https://docs.gitlab.com/api/merge_request_approval_settings/)
[Merge request context commits](https://docs.gitlab.com/api/merge_request_context_commits/)
[Merge requests](https://docs.gitlab.com/api/merge_requests/)
[Merge trains](https://docs.gitlab.com/api/merge_trains/)
[Metadata](https://docs.gitlab.com/api/metadata/)
[Model registry](https://docs.gitlab.com/api/model_registry/)
[Namespaces](https://docs.gitlab.com/api/namespaces/)
[Notes (comments)](https://docs.gitlab.com/api/notes/)
[Notification settings](https://docs.gitlab.com/api/notification_settings/)
[npm](https://docs.gitlab.com/api/packages/npm/)
[NuGet](https://docs.gitlab.com/api/packages/nuget/)
[Organizations](https://docs.gitlab.com/api/organizations/)
[Packages](https://docs.gitlab.com/api/packages/)
[Pages domains](https://docs.gitlab.com/api/pages_domains/)
[Personal access tokens](https://docs.gitlab.com/api/personal_access_tokens/)
[Pipeline schedules](https://docs.gitlab.com/api/pipeline_schedules/)
[Pipeline trigger tokens](https://docs.gitlab.com/api/pipeline_triggers/)
[Pipelines](https://docs.gitlab.com/api/pipelines/)
[Plan limits](https://docs.gitlab.com/api/plan_limits/)
[Product analytics](https://docs.gitlab.com/api/product_analytics/)
[Projects](https://docs.gitlab.com/api/projects/)
[Access tokens](https://docs.gitlab.com/api/project_access_tokens/)
[Aliases](https://docs.gitlab.com/api/project_aliases/)
[Badges](https://docs.gitlab.com/api/project_badges/)
[CI/CD variables](https://docs.gitlab.com/api/project_level_variables/)
[Forks](https://docs.gitlab.com/api/project_forks/)
[Import and export](https://docs.gitlab.com/api/project_import_export/)
[Integrations](https://docs.gitlab.com/api/project_integrations/)
[Issue boards](https://docs.gitlab.com/api/boards/)
[Iterations](https://docs.gitlab.com/api/iterations/)
[Labels](https://docs.gitlab.com/api/labels/)
[Members](https://docs.gitlab.com/api/project_members/)
[Markdown uploads](https://docs.gitlab.com/api/project_markdown_uploads/)
[Milestones](https://docs.gitlab.com/api/milestones/)
[Project starring](https://docs.gitlab.com/api/project_starring/)
[Protected branches](https://docs.gitlab.com/api/protected_branches/)
[Protected environments](https://docs.gitlab.com/api/protected_environments/)
[Protected packages](https://docs.gitlab.com/api/project_packages_protection_rules/)
[Protected tags](https://docs.gitlab.com/api/protected_tags/)
[Pull mirroring](https://docs.gitlab.com/api/project_pull_mirroring/)
[Push rules](https://docs.gitlab.com/api/project_push_rules/)
[Relations export](https://docs.gitlab.com/api/project_relations_export/)
[Releases](https://docs.gitlab.com/api/releases/)
[Release links](https://docs.gitlab.com/api/releases/links/)
[Remote mirrors](https://docs.gitlab.com/api/remote_mirrors/)
[Repository storage moves](https://docs.gitlab.com/api/project_repository_storage_moves/)
[Security settings](https://docs.gitlab.com/api/project_security_settings/)
[Snippets](https://docs.gitlab.com/api/project_snippets/)
[Statistics](https://docs.gitlab.com/api/project_statistics/)
[Templates](https://docs.gitlab.com/api/project_templates/)
[Vulnerabilities](https://docs.gitlab.com/api/project_vulnerabilities/)
[Webhooks](https://docs.gitlab.com/api/project_webhooks/)
[Wikis](https://docs.gitlab.com/api/wikis/)
[PyPI](https://docs.gitlab.com/api/packages/pypi/)
[Repositories](https://docs.gitlab.com/api/repositories/)
[Repository files](https://docs.gitlab.com/api/repository_files/)
[Repository submodules](https://docs.gitlab.com/api/repository_submodules/)
[Resource group](https://docs.gitlab.com/api/resource_groups/)
[Resource iteration events](https://docs.gitlab.com/api/resource_iteration_events/)
[Resource label events](https://docs.gitlab.com/api/resource_label_events/)
[Resource milestone events](https://docs.gitlab.com/api/resource_milestone_events/)
[Resource state events](https://docs.gitlab.com/api/resource_state_events/)
[Resource weight events](https://docs.gitlab.com/api/resource_weight_events/)
[Ruby gems](https://docs.gitlab.com/api/packages/rubygems/)
[Runners](https://docs.gitlab.com/api/runners/)
[Runner controllers](https://docs.gitlab.com/api/runner_controllers/)
[Runner controller tokens](https://docs.gitlab.com/api/runner_controller_tokens/)
[Search](https://docs.gitlab.com/api/search/)
[Search migrations](https://docs.gitlab.com/api/search_admin/)
[Secure files](https://docs.gitlab.com/api/secure_files/)
[Service accounts](https://docs.gitlab.com/api/service_accounts/)
[Service Ping](https://docs.gitlab.com/api/usage_data/)
[Sidekiq metrics](https://docs.gitlab.com/api/sidekiq_metrics/)
[Sidekiq queues](https://docs.gitlab.com/api/admin_sidekiq_queues/)
[Snippet repository storage moves](https://docs.gitlab.com/api/snippet_repository_storage_moves/)
[Snippets](https://docs.gitlab.com/api/snippets/)
[Suggestions](https://docs.gitlab.com/api/suggestions/)
[System hooks](https://docs.gitlab.com/api/system_hooks/)
[Tags](https://docs.gitlab.com/api/tags/)
[Terraform registry](https://docs.gitlab.com/api/packages/terraform-modules/)
[To-Do List](https://docs.gitlab.com/api/todos/)
[Token information](https://docs.gitlab.com/api/admin/token/)
[Topics](https://docs.gitlab.com/api/topics/)
[Users](https://docs.gitlab.com/api/users/)
[Version](https://docs.gitlab.com/api/version/)
[Virtual registries cleanup policies](https://docs.gitlab.com/api/virtual_registries_cleanup_policies/)
[Vulnerabilities](https://docs.gitlab.com/api/vulnerabilities/)
[Vulnerability archive export](https://docs.gitlab.com/api/vulnerability_archive_exports/)
[Vulnerability export](https://docs.gitlab.com/api/vulnerability_exports/)
[Vulnerability findings](https://docs.gitlab.com/api/vulnerability_findings/)
[Web commits](https://docs.gitlab.com/api/web_commits/)
[Authentication](https://docs.gitlab.com/api/rest/authentication/)
[Third-party clients](https://docs.gitlab.com/api/rest/third_party_clients/)
[Deprecations and removals](https://docs.gitlab.com/api/rest/deprecations/)
[OpenAPI](https://docs.gitlab.com/api/openapi/openapi_interactive/)
[Automate storage management](https://docs.gitlab.com/user/storage_management_automation/)
[Troubleshooting](https://docs.gitlab.com/api/rest/troubleshooting/)
[GraphQL API](https://docs.gitlab.com/api/graphql/)
[OAuth 2.0 identity provider API](https://docs.gitlab.com/api/oauth2/)
[GitLab Duo CLI (duo)](https://docs.gitlab.com/user/gitlab_duo_cli/)
[GitLab CLI (glab)](https://docs.gitlab.com/cli/)
[Editor and IDE extensions](https://docs.gitlab.com/editor_extensions/)
/
  1. [GitLab Docs](https://docs.gitlab.com/)
  2. [Extend](https://docs.gitlab.com/api/)
  3. [REST API](https://docs.gitlab.com/api/rest/)
  4. [Resources](https://docs.gitlab.com/api/api_resources/)
  5. [Projects](https://docs.gitlab.com/api/projects/)
  6. [Protected branches](https://docs.gitlab.com/api/protected_branches/)


* * *
# Protected branches API
  * Tier: Free, Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


Use this API to manage [protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/).
GitLab Premium and GitLab Ultimate support more granular protections for pushing to branches. Administrators can grant permission to modify and push to protected branches only to deploy keys, instead of specific users.
## Valid access levels[](https://docs.gitlab.com/api/protected_branches/#valid-access-levels "Permalink")
The `ProtectedRefAccess.allowed_access_levels` method defines the following access levels:
  * `0`: No access
  * `30`: Developer role
  * `40`: Maintainer role
  * `60`: Administrator


## List protected branches[](https://docs.gitlab.com/api/protected_branches/#list-protected-branches "Permalink")
History
  * Deploy key information [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116846) in GitLab 16.0.


Get a list of [protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) from a project as they are defined in the UI. If a wildcard is set, it is returned instead of the exact name of the branches that match that wildcard.
```
GET /projects/:id/protected_branches
```

Supported attributes:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | Yes | ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`search` | string | No | Name or part of the name of protected branches to search for.
If successful, returns [`200 OK`](https://docs.gitlab.com/api/rest/troubleshooting/#status-codes) and the following response attributes:
Attribute | Type | Description
---|---|---
`allow_force_push` | boolean | If `true`, force push is allowed on this branch.
`code_owner_approval_required` | boolean | If `true`, code owner approval is required for pushes to this branch.
`id` | integer | ID of the protected branch.
`inherited` | boolean | If `true`, protection settings are inherited from parent group. Premium and Ultimate only.
`merge_access_levels` | array | Array of merge access level configurations.
`merge_access_levels[].access_level` | integer | Access level for merging.
`merge_access_levels[].access_level_description` | string | Human-readable description of the access level.
`merge_access_levels[].group_id` | integer | ID of the group with merge access. Premium and Ultimate only.
`merge_access_levels[].id` | integer | ID of the merge access level configuration.
`merge_access_levels[].user_id` | integer | ID of the user with merge access. Premium and Ultimate only.
`name` | string | Name of the protected branch.
`push_access_levels` | array | Array of push access level configurations.
`push_access_levels[].access_level` | integer | Access level for pushing.
`push_access_levels[].access_level_description` | string | Human-readable description of the access level.
`push_access_levels[].deploy_key_id` | integer | ID of the deploy key with push access.
`push_access_levels[].group_id` | integer | ID of the group with push access. Premium and Ultimate only.
`push_access_levels[].id` | integer | ID of the push access level configuration.
`push_access_levels[].user_id` | integer | ID of the user with push access. Premium and Ultimate only.
In the following example request, the project ID is `5`.
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches"
```

The following example response includes:
  * Two protected branches with IDs `100` and `101`.
  * `push_access_levels` with IDs `1001`, `1002`, and `1003`.
  * `merge_access_levels` with IDs `2001` and `2002`.


json
```
[
  {
    "id": 100,
    "name": "main",
    "push_access_levels": [
      {
        "id":  1001,
        "access_level": 40,
        "access_level_description": "Maintainers"
      },
      {
        "id": 1002,
        "access_level": 40,
        "access_level_description": "Deploy key",
        "deploy_key_id": 1
      }
    ],
    "merge_access_levels": [
      {
        "id":  2001,
        "access_level": 40,
        "access_level_description": "Maintainers"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  },
  {
    "id": 101,
    "name": "release/*",
    "push_access_levels": [
      {
        "id":  1003,
        "access_level": 40,
        "access_level_description": "Maintainers"
      }
    ],
    "merge_access_levels": [
      {
        "id":  2002,
        "access_level": 40,
        "access_level_description": "Maintainers"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  }
]
```

Users on GitLab Premium or Ultimate also see the `user_id`, `group_id`, and `inherited` parameters. If the `inherited` parameter exists, the setting was inherited from the project’s group.
The following example response includes:
  * One protected branch with ID `100`.
  * `push_access_levels` with IDs `1001` and `1002`.
  * `merge_access_levels` with ID `2001`.


json
```
[
  {
    "id": 101,
    "name": "main",
    "push_access_levels": [
      {
        "id":  1001,
        "access_level": 40,
        "user_id": null,
        "group_id": null,
        "access_level_description": "Maintainers"
      },
      {
        "id": 1002,
        "access_level": 40,
        "access_level_description": "Deploy key",
        "deploy_key_id": 1,
        "user_id": null,
        "group_id": null
      }
    ],
    "merge_access_levels": [
      {
        "id":  2001,
        "access_level": null,
        "user_id": null,
        "group_id": 1234,
        "access_level_description": "Example Merge Group"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false,
    "inherited": true
  }
]
```

## Retrieve a protected branch or wildcard protected branch[](https://docs.gitlab.com/api/protected_branches/#retrieve-a-protected-branch-or-wildcard-protected-branch "Permalink")
Retrieves a specified protected branch or wildcard protected branch.
```
GET /projects/:id/protected_branches/:name
```

Supported attributes:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | Yes | ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`name` | string | Yes | Name of the branch or wildcard.
If successful, returns [`200 OK`](https://docs.gitlab.com/api/rest/troubleshooting/#status-codes) and the following response attributes:
Attribute | Type | Description
---|---|---
`allow_force_push` | boolean | If `true`, force push is allowed on this branch.
`code_owner_approval_required` | boolean | If `true`, code owner approval is required for pushes to this branch.
`id` | integer | ID of the protected branch.
`merge_access_levels` | array | Array of merge access level configurations.
`merge_access_levels[].access_level` | integer | Access level for merging.
`merge_access_levels[].access_level_description` | string | Human-readable description of the access level.
`merge_access_levels[].group_id` | integer | ID of the group with merge access. Premium and Ultimate only.
`merge_access_levels[].id` | integer | ID of the merge access level configuration.
`merge_access_levels[].user_id` | integer | ID of the user with merge access. Premium and Ultimate only.
`name` | string | Name of the protected branch.
`push_access_levels` | array | Array of push access level configurations.
`push_access_levels[].access_level` | integer | Access level for pushing.
`push_access_levels[].access_level_description` | string | Human-readable description of the access level.
`push_access_levels[].group_id` | integer | ID of the group with push access. Premium and Ultimate only.
`push_access_levels[].id` | integer | ID of the push access level configuration.
`push_access_levels[].user_id` | integer | ID of the user with push access. Premium and Ultimate only.
In the following example request, the project ID is `5` and branch name is `main`:
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches/main"
```

Example response:
json
```
{
  "id": 101,
  "name": "main",
  "push_access_levels": [
    {
      "id":  1001,
      "access_level": 40,
      "access_level_description": "Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  2001,
      "access_level": 40,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}
```

Users on GitLab Premium or Ultimate also see the `user_id` and `group_id` parameters.
Example response:
json
```
{
  "id": 101,
  "name": "main",
  "push_access_levels": [
    {
      "id":  1001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  2001,
      "access_level": null,
      "user_id": null,
      "group_id": 1234,
      "access_level_description": "Example Merge Group"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}
```

## Protect repository branches[](https://docs.gitlab.com/api/protected_branches/#protect-repository-branches "Permalink")
History
  * `deploy_key_id` configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166598) in GitLab 17.5.


Protect a single repository branch or several project repository branches using a wildcard protected branch.
```
POST /projects/:id/protected_branches
```

Supported attributes:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | Yes | ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`name` | string | Yes | Name of the branch or wildcard.
`allow_force_push` | boolean | No | If `true`, members who can push to this branch can also force push. Default is `false`.
`allowed_to_merge` | array | No | Array of merge access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only.
`allowed_to_push` | array | No | Array of push access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, `{deploy_key_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only.
`allowed_to_unprotect` | array | No | Array of unprotect access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Access level `No access` is not available for this field. Premium and Ultimate only.
`code_owner_approval_required` | boolean | No | If `true`, prevents pushes to this branch if it matches an item in the [`CODEOWNERS` file](https://docs.gitlab.com/user/project/codeowners/). Default is `false`. Premium and Ultimate only.
`merge_access_level` | integer | No | Access levels allowed to merge. Default is `40` (Maintainer role).
`push_access_level` | integer | No | Access levels allowed to push. Default is `40` (Maintainer role).
`unprotect_access_level` | integer | No | Access levels allowed to unprotect. Default is `40` (Maintainer role).
When you configure access levels:
  * You can set multiple access levels simultaneously for `allowed_to_push` and `allowed_to_merge`.
  * The most permissive access level determines who can perform the action.


This behavior differs from the UI, which automatically clears other role selections when you select **No one** (`access_level: 0`).
If successful, returns [`201 Created`](https://docs.gitlab.com/api/rest/troubleshooting/#status-codes) and the following response attributes:
Attribute | Type | Description
---|---|---
`allow_force_push` | boolean | If `true`, force push is allowed on this branch.
`code_owner_approval_required` | boolean | If `true`, code owner approval is required for pushes to this branch.
`id` | integer | ID of the protected branch.
`merge_access_levels` | array | Array of merge access level configurations.
`merge_access_levels[].access_level` | integer | Access level for merging.
`merge_access_levels[].access_level_description` | string | Human-readable description of the access level.
`merge_access_levels[].group_id` | integer | ID of the group with merge access. Premium and Ultimate only.
`merge_access_levels[].id` | integer | ID of the merge access level configuration.
`merge_access_levels[].user_id` | integer | ID of the user with merge access. Premium and Ultimate only.
`name` | string | Name of the protected branch.
`push_access_levels` | array | Array of push access level configurations.
`push_access_levels[].access_level` | integer | Access level for pushing.
`push_access_levels[].access_level_description` | string | Human-readable description of the access level.
`push_access_levels[].deploy_key_id` | integer | ID of the deploy key with push access.
`push_access_levels[].group_id` | integer | ID of the group with push access. Premium and Ultimate only.
`push_access_levels[].id` | integer | ID of the push access level configuration.
`push_access_levels[].user_id` | integer | ID of the user with push access. Premium and Ultimate only.
`unprotect_access_levels` | array | Array of unprotect access level configurations.
`unprotect_access_levels[].access_level` | integer | Access level for unprotecting.
`unprotect_access_levels[].access_level_description` | string | Human-readable description of the access level.
`unprotect_access_levels[].group_id` | integer | ID of the group with unprotect access. Premium and Ultimate only.
`unprotect_access_levels[].id` | integer | ID of the unprotect access level configuration.
`unprotect_access_levels[].user_id` | integer | ID of the user with unprotect access. Premium and Ultimate only.
In the following example request, the project ID is `5` and branch name is `*-stable`.
shell
```
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40"
```

The example response includes:
  * A protected branch with ID `101`.
  * `push_access_levels` with ID `1001`.
  * `merge_access_levels` with ID `2001`.
  * `unprotect_access_levels` with ID `3001`.


json
```
{
  "id": 101,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1001,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  2001,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  3001,
      "access_level": 40,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}
```

Users on GitLab Premium or Ultimate also see the `user_id` and `group_id` parameters:
The following example response includes:
  * A protected branch with ID `101`.
  * `push_access_levels` with ID `1001`.
  * `merge_access_levels` with ID `2001`.
  * `unprotect_access_levels` with ID `3001`.


json
```
{
  "id": 1,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1001,
      "access_level": 30,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  2001,
      "access_level": 30,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  3001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}
```

### Example with user push access and group merge access[](https://docs.gitlab.com/api/protected_branches/#example-with-user-push-access-and-group-merge-access "Permalink")
  * Tier: Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](https://docs.gitlab.com/user/project/members/sharing_projects_groups/). These access levels allow more granular control over protected branch access. For more information, see [configure group permissions](https://docs.gitlab.com/user/project/repository/branches/protected/#with-group-permissions).
The following example request creates a protected branch with user push access and group merge access. The `user_id` is `2` and the `group_id` is `3`.
shell
```
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=2&allowed_to_merge%5B%5D%5Bgroup_id%5D=3"
```

The following example response includes:
  * A protected branch with ID `101`.
  * `push_access_levels` with ID `1001`.
  * `merge_access_levels` with ID `2001`.
  * `unprotect_access_levels` with ID `3001`.


json
```
{
  "id": 101,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1001,
      "access_level": null,
      "user_id": 2,
      "group_id": null,
      "access_level_description": "Administrator"
    }
  ],
  "merge_access_levels": [
    {
      "id":  2001,
      "access_level": null,
      "user_id": null,
      "group_id": 3,
      "access_level_description": "Example Merge Group"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  3001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}
```

### Example with deploy key access[](https://docs.gitlab.com/api/protected_branches/#example-with-deploy-key-access "Permalink")
  * Tier: Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


History
  * [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166598) in GitLab 17.5.


Elements in the `allowed_to_push` array should take the form `{user_id: integer}`, `{group_id: integer}`, `{deploy_key_id: integer}`, or `{access_level: integer}`. The deploy key must be enabled for your project and it must have write access to your project repository. For other requirements, see [Allow deploy keys to push to a protected branch](https://docs.gitlab.com/user/project/repository/branches/protected/#enable-deploy-key-access).
Example request:
shell
```
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push[][deploy_key_id]=1"
```

The following example response includes:
  * A protected branch with ID `101`.
  * `push_access_levels` with ID `1001`.
  * `merge_access_levels` with ID `2001`.
  * `unprotect_access_levels` with ID `3001`.


json
```
{
  "id": 101,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1001,
      "access_level": null,
      "user_id": null,
      "group_id": null,
      "deploy_key_id": 1,
      "access_level_description": "Deploy"
    }
  ],
  "merge_access_levels": [
    {
      "id":  2001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  3001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}
```

### Example with allow to push and allow to merge access[](https://docs.gitlab.com/api/protected_branches/#example-with-allow-to-push-and-allow-to-merge-access "Permalink")
  * Tier: Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


History
  * Moved to GitLab Premium in 13.9.


Example request:
shell
```
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "main",
    "allowed_to_push": [
      {"access_level": 30}
    ],
    "allowed_to_merge": [
      {"access_level": 30},
      {"access_level": 40}
    ]
  }' \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches"
```

The following example response includes:
  * A protected branch with ID `105`.
  * `push_access_levels` with ID `1001`.
  * `merge_access_levels` with IDs `2001` and `2002`.
  * `unprotect_access_levels` with ID `3001`.


json
```
{
    "id": 105,
    "name": "main",
    "push_access_levels": [
        {
            "id": 1001,
            "access_level": 30,
            "access_level_description": "Developers + Maintainers",
            "user_id": null,
            "group_id": null
        }
    ],
    "merge_access_levels": [
        {
            "id": 2001,
            "access_level": 30,
            "access_level_description": "Developers + Maintainers",
            "user_id": null,
            "group_id": null
        },
        {
            "id": 2002,
            "access_level": 40,
            "access_level_description": "Maintainers",
            "user_id": null,
            "group_id": null
        }
    ],
    "unprotect_access_levels": [
        {
            "id": 3001,
            "access_level": 40,
            "access_level_description": "Maintainers",
            "user_id": null,
            "group_id": null
        }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
}
```

### Examples with unprotect access levels[](https://docs.gitlab.com/api/protected_branches/#examples-with-unprotect-access-levels "Permalink")
  * Tier: Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


To create a protected branch where only a specific group can unprotect the branch:
shell
```
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "production",
    "allowed_to_unprotect": [
      {"group_id": 789}
    ]
  }' \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches"
```

To allow multiple types of users to unprotect a branch:
shell
```
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "main",
    "allowed_to_unprotect": [
      {"user_id": 123},
      {"group_id": 456},
      {"access_level": 40}
    ]
  }' \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches"
```

This configuration allows these users to unprotect the branch:
  * The user with ID `123`.
  * Members of the group with ID `456`.
  * Users with the Maintainer or Owner role (access level 40).


## Unprotect repository branches[](https://docs.gitlab.com/api/protected_branches/#unprotect-repository-branches "Permalink")
Unprotect the given protected branch or wildcard protected branch.
```
DELETE /projects/:id/protected_branches/:name
```

Supported attributes:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | Yes | ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`name` | string | Yes | Name of the branch.
If successful, returns [`204 No Content`](https://docs.gitlab.com/api/rest/troubleshooting/#status-codes).
In the following example request, the project ID is `5` and branch name is `*-stable`:
shell
```
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"
```

## Update a protected branch[](https://docs.gitlab.com/api/protected_branches/#update-a-protected-branch "Permalink")
History
  * `deploy_key_id` configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/166598) in GitLab 17.5.


Update a protected branch.
```
PATCH /projects/:id/protected_branches/:name
```

Supported attributes:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | Yes | ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`name` | string | Yes | Name of the branch or wildcard.
`allow_force_push` | boolean | No | If `true`, members who can push to this branch can also force push.
`allowed_to_merge` | array | No | Array of merge access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only.
`allowed_to_push` | array | No | Array of push access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, `{deploy_key_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only.
`allowed_to_unprotect` | array | No | Array of unprotect access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, `{access_level: integer}`, or `{id: integer, _destroy: true}` to destroy an existing access level. Access level `No access` is not available for this field. Premium and Ultimate only.
`code_owner_approval_required` | boolean | No | If `true`, prevents pushes to this branch if it matches an item in the [`CODEOWNERS` file](https://docs.gitlab.com/user/project/codeowners/). Premium and Ultimate only.
For information about how access levels interact when you set multiple values, see [Protect repository branches](https://docs.gitlab.com/api/protected_branches/#protect-repository-branches).
If successful, returns [`200 OK`](https://docs.gitlab.com/api/rest/troubleshooting/#status-codes) and the following response attributes:
Attribute | Type | Description
---|---|---
`allow_force_push` | boolean | If `true`, force push is allowed on this branch.
`code_owner_approval_required` | boolean | If `true`, code owner approval is required for pushes to this branch.
`id` | integer | ID of the protected branch.
`merge_access_levels` | array | Array of merge access level configurations.
`merge_access_levels[].access_level` | integer | Access level for merging.
`merge_access_levels[].access_level_description` | string | Human-readable description of the access level.
`merge_access_levels[].group_id` | integer | ID of the group with merge access. Premium and Ultimate only.
`merge_access_levels[].id` | integer | ID of the merge access level configuration.
`merge_access_levels[].user_id` | integer | ID of the user with merge access. Premium and Ultimate only.
`name` | string | Name of the protected branch.
`push_access_levels` | array | Array of push access level configurations.
`push_access_levels[].access_level` | integer | Access level for pushing.
`push_access_levels[].access_level_description` | string | Human-readable description of the access level.
`push_access_levels[].deploy_key_id` | integer | ID of the deploy key with push access.
`push_access_levels[].group_id` | integer | ID of the group with push access. Premium and Ultimate only.
`push_access_levels[].id` | integer | ID of the push access level configuration.
`push_access_levels[].user_id` | integer | ID of the user with push access. Premium and Ultimate only.
`unprotect_access_levels` | array | Array of unprotect access level configurations.
`unprotect_access_levels[].access_level` | integer | Access level for unprotecting.
`unprotect_access_levels[].access_level_description` | string | Human-readable description of the access level.
`unprotect_access_levels[].group_id` | integer | ID of the group with unprotect access. Premium and Ultimate only.
`unprotect_access_levels[].id` | integer | ID of the unprotect access level configuration.
`unprotect_access_levels[].user_id` | integer | ID of the user with unprotect access. Premium and Ultimate only.
Example request:
shell
```
curl --request PATCH \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch?allow_force_push=true&code_owner_approval_required=true"
```

Elements in the `allowed_to_push`, `allowed_to_merge`, and `allowed_to_unprotect` arrays should be one of `user_id`, `group_id`, or `access_level`, and take the form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`.
`allowed_to_push` includes an extra element, `deploy_key_id`, that takes the form `{deploy_key_id: integer}`.
To update:
  * `user_id`: Ensure the updated user has access to the project. You must also pass the `id` of the `access_level` in the respective hash.
  * `group_id`: Ensure the updated group [has this project shared](https://docs.gitlab.com/user/project/members/sharing_projects_groups/). You must also pass the `id` of the `access_level` in the respective hash.
  * `deploy_key_id`: Ensure the deploy key is enabled for your project and it must have write access to your project repository.


To delete, you must pass `_destroy` set to `true`. See the following examples.
### Example: create a `push_access_level` record[](https://docs.gitlab.com/api/protected_branches/#example-create-a-push_access_level-record "Permalink")
shell
```
curl --header 'Content-Type: application/json' --request PATCH \
  --data '{"allowed_to_push": [{"access_level": 40}]}' \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/22034114/protected_branches/main"
```

Example response:
json
```
{
   "name": "main",
   "push_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "Maintainers",
         "user_id": null,
         "group_id": null
      }
   ]
}
```

### Example: update a `push_access_level` record[](https://docs.gitlab.com/api/protected_branches/#example-update-a-push_access_level-record "Permalink")
shell
```
curl --header 'Content-Type: application/json' --request PATCH \
  --data '{"allowed_to_push": [{"id": 12, "access_level": 0}]}' \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/22034114/protected_branches/main"
```

Example response:
json
```
{
   "name": "main",
   "push_access_levels": [
      {
         "id": 12,
         "access_level": 0,
         "access_level_description": "No One",
         "user_id": null,
         "group_id": null
      }
   ]
}
```

### Example: delete a `push_access_level` record[](https://docs.gitlab.com/api/protected_branches/#example-delete-a-push_access_level-record "Permalink")
shell
```
curl --header 'Content-Type: application/json' --request PATCH \
  --data '{"allowed_to_push": [{"id": 12, "_destroy": true}]}' \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/22034114/protected_branches/main"
```

Example response:
json
```
{
   "name": "main",
   "push_access_levels": []
}
```

### Example: update an `unprotect_access_level` record[](https://docs.gitlab.com/api/protected_branches/#example-update-an-unprotect_access_level-record "Permalink")
Prerequisites:
  * Users calling this API must be included in the `allowed_to_unprotect` configuration.
  * The user specified by `user_id` must be a project member.
  * Groups specified by `group_id` must have access to the project.


To modify who can unprotect an existing protected branch, include the `id` of the existing access level record. For example:
shell
```
curl --request PATCH \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "allowed_to_unprotect": [
      {"id": 17486, "user_id": 3791}
    ]
  }' \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches/main"
```

To remove specific access levels, use `_destroy: true`.
## Related topics[](https://docs.gitlab.com/api/protected_branches/#related-topics "Permalink")
  * [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/)
  * [Branches](https://docs.gitlab.com/user/project/repository/branches/)
  * [Branches API](https://docs.gitlab.com/api/branches/)


Was this page helpful?YesNo
Edit this page
  *     * [ Open in Web IDE`.`Quickly and easily edit multiple files. ](https://gitlab.com/-/ide/project/gitlab-org/gitlab/edit/master/-/doc/api/protected_branches.md)
    * [ View page sourceEdit this file only. ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/protected_branches.md)
    * [ Create an issueSuggest improvements. ](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Documentation)


  * [Valid access levels](https://docs.gitlab.com/api/protected_branches/#valid-access-levels)
  * [List protected branches](https://docs.gitlab.com/api/protected_branches/#list-protected-branches)
  * [Retrieve a protected branch or wildcard protected branch](https://docs.gitlab.com/api/protected_branches/#retrieve-a-protected-branch-or-wildcard-protected-branch)
  * [Protect repository branches](https://docs.gitlab.com/api/protected_branches/#protect-repository-branches)
  * [Example with user push access and group merge access](https://docs.gitlab.com/api/protected_branches/#example-with-user-push-access-and-group-merge-access)
  * [Example with deploy key access](https://docs.gitlab.com/api/protected_branches/#example-with-deploy-key-access)
  * [Example with allow to push and allow to merge access](https://docs.gitlab.com/api/protected_branches/#example-with-allow-to-push-and-allow-to-merge-access)
  * [Examples with unprotect access levels](https://docs.gitlab.com/api/protected_branches/#examples-with-unprotect-access-levels)
  * [Unprotect repository branches](https://docs.gitlab.com/api/protected_branches/#unprotect-repository-branches)
  * [Update a protected branch](https://docs.gitlab.com/api/protected_branches/#update-a-protected-branch)
  * [Example: create a push_access_level record](https://docs.gitlab.com/api/protected_branches/#example-create-a-push_access_level-record)
  * [Example: update a push_access_level record](https://docs.gitlab.com/api/protected_branches/#example-update-a-push_access_level-record)
  * [Example: delete a push_access_level record](https://docs.gitlab.com/api/protected_branches/#example-delete-a-push_access_level-record)
  * [Example: update an unprotect_access_level record](https://docs.gitlab.com/api/protected_branches/#example-update-an-unprotect_access_level-record)
  * [Related topics](https://docs.gitlab.com/api/protected_branches/#related-topics)


[![GitLab Docs logo](https://docs.gitlab.com/gitlab-logo-footer.svg)](https://docs.gitlab.com/)
  * [Facebook](https://www.facebook.com/gitlab)
  * [LinkedIn](https://www.linkedin.com/company/gitlab-com)
  * [Twitter](https://twitter.com/gitlab)
  * [YouTube](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg)

[![Creative Commons License](https://docs.gitlab.com/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
Company
  * [About GitLab](https://about.gitlab.com/company/)
  * [View pricing](https://about.gitlab.com/pricing/)
  * [Try GitLab for free](https://about.gitlab.com/free-trial/)


Feedback
  * [View page source](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/protected_branches.md)
  * [Edit in Web IDE](https://gitlab.com/-/ide/project/gitlab-org/gitlab/edit/master/-/doc/api/protected_branches.md)
  * [Contribute to GitLab](https://about.gitlab.com/community/contribute/)
  * [Suggest updates](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Documentation)


Help & Community
  * [Get certified](https://university.gitlab.com/pages/certifications)
  * [Get support](https://about.gitlab.com/support/)
  * [Post on the GitLab forum](https://forum.gitlab.com/new-topic?title=topic%20title&body=topic%20body&tags=docs-feedback)


Resources
  * [Terms](https://about.gitlab.com/terms/)
  * [Privacy statement](https://about.gitlab.com/privacy/)
  * [Use of generative AI](https://docs.gitlab.com/legal/use_generative_ai/)
  * [Acceptable use of user licenses](https://docs.gitlab.com/legal/licensing_policy/)
  * Cookie Preferences


![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Fproject_templates%2F&_biz_t=1772174427941&_biz_i=Project%20templates%20API%20%7C%20GitLab%20Docs&_biz_n=137&rnd=208252&cdn_o=a&_biz_z=1772174428203)![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Fprotected_environments%2F&_biz_t=1772174428018&_biz_i=Protected%20environments%20API%20%7C%20GitLab%20Docs&_biz_n=138&rnd=305960&cdn_o=a&_biz_z=1772174428203)![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Fprotected_branches%2F&_biz_t=1772174428202&_biz_i=Protected%20branches%20API%20%7C%20GitLab%20Docs&_biz_n=139&rnd=775747&cdn_o=a&_biz_z=1772174428204)
![Company Logo](https://cdn.cookielaw.org/logos/aa14a5c8-79e3-442a-8177-464ad850b19d/e46c1d0d-1f66-481f-bc06-5427671431da/253e6fee-c4c0-4b60-bc35-79cdae5dda32/gitlab-logo-100.png)
## Privacy Preference Center
## Privacy Preference Center
  * ### Your Privacy
  * ### Strictly Necessary Cookies
  * ### Functionality Cookies
  * ### Performance and Analytics Cookies
  * ### Targeting and Advertising Cookies
  * ### Ad User Data
  * ### Ad Personalization


#### Your Privacy
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
[Cookie Policy](https://about.gitlab.com/privacy/cookies/)
**User ID:** 42fad8d5-ed56-4786-8d74-3c72635252d2
_This User ID will be used as a unique identifier while storing and accessing your preferences for future._
**Timestamp:** --
#### Strictly Necessary Cookies
Always Active
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, enabling you to securely log into the site, filling in forms, or using the customer checkout. GitLab processes any personal data collected through these cookies on the basis of our legitimate interest.
Cookies Details
#### Functionality Cookies
Functionality Cookies
These cookies enable helpful but non-essential website functions that improve your website experience. By recognizing you when you return to our website, they may, for example, allow us to personalize our content for you or remember your preferences. If you do not allow these cookies then some or all of these services may not function properly. GitLab processes any personal data collected through these cookies on the basis of your consent
Cookies Details
#### Performance and Analytics Cookies
Performance and Analytics Cookies
These cookies allow us and our third-party service providers to recognize and count the number of visitors on our websites and to see how visitors move around our websites when they are using it. This helps us improve our products and ensures that users can easily find what they need on our websites. These cookies usually generate aggregate statistics that are not associated with an individual. To the extent any personal data is collected through these cookies, GitLab processes that data on the basis of your consent.
Cookies Details
#### Targeting and Advertising Cookies
Targeting and Advertising Cookies
These cookies enable different advertising related functions. They may allow us to record information about your visit to our websites, such as pages visited, links followed, and videos viewed so we can make our websites and the advertising displayed on it more relevant to your interests. They may be set through our website by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant advertisements on other websites. GitLab processes any personal data collected through these cookies on the basis of your consent.
Cookies Details
#### Ad User Data
Ad User Data
Sets consent for sending user data to Google for advertising purposes.
Cookies Details
#### Ad Personalization
Ad Personalization
Sets consent for personalized advertising.
Cookies Details
Back Button
### Cookie List
Filter Button
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label
Clear
  * checkbox label label


Apply Cancel
Confirm My Choices
Allow All
[![Powered by Onetrust](https://cdn.cookielaw.org/logos/static/powered_by_logo.svg)](https://www.onetrust.com/products/cookie-consent/)
