GIgitlab
protected_branches

List all protected branches

Lists all protected branches for a specified project.

get/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

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

searchstring

Search for a protected branch by name

Response

List all protected 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.