GIgitlab
protected_branches

Protect repository branches

Protects a specified repository branch or several project repository branches using a wildcard protected branch.

post/api/v4/projects/{id}/protected_branches

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project

Request body

namestring required

The name of the protected branch

push_access_level30 | 40 | 60 | 0

Access levels allowed to push (defaults: 40, maintainer access level)

merge_access_level30 | 40 | 60 | 0

Access levels allowed to merge (defaults: 40, maintainer access level)

allow_force_pushboolean

Allow force push for all users with push access.

unprotect_access_level30 | 40 | 60

Access levels allowed to unprotect (defaults: 40, maintainer access level)

code_owner_approval_requiredboolean

Prevent pushes to this branch if it matches an item in CODEOWNERS

Example request

{
  "name": "main",
  "allowed_to_push": [
    {
      "deploy_key_id": 1,
      "user_id": 1,
      "group_id": 1,
      "member_role_id": 1,
      "id": 40
    }
  ],
  "allowed_to_merge": [
    {
      "user_id": 1,
      "group_id": 1,
      "member_role_id": 1,
      "id": 40
    }
  ],
  "allowed_to_unprotect": [
    {
      "user_id": 1,
      "group_id": 1,
      "member_role_id": 1,
      "id": 40
    }
  ]
}

Response

Protect repository branches

idinteger required
namestring required
allow_force_pushboolean required
code_owner_approval_requiredboolean required
inheritedboolean required

Example response

{
  "id": 1,
  "name": "main",
  "push_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "deploy_key_id": 1,
      "user_id": 1,
      "group_id": 1,
      "member_role_id": 42,
      "member_role_name": "Lead Developer"
    }
  ],
  "merge_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "deploy_key_id": 1,
      "user_id": 1,
      "group_id": 1,
      "member_role_id": 42,
      "member_role_name": "Lead Developer"
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "deploy_key_id": 1,
      "user_id": 1,
      "group_id": 1,
      "member_role_id": 42,
      "member_role_name": "Lead Developer"
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.