受保护的分支 API

有效的访问级别

访问级别定义在方法 ProtectedRefAccess.allowed_access_levels 中。目前，这些级别是已经确认的：

0  => No access
30 => Developer access
40 => Maintainer access
60 => Admin access

列出受保护的分支

  • 部署 key 信息引入于极狐GitLab 16.0。

从项目中获取 UI 中定义的受保护分支列表。如果设置了通配符，则返回通配符，而不是与该通配符匹配的分支的具体名称。

GET /projects/:id/protected_branches
参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的项目的 ID 或 URL 编码的路径
search string no 要搜索的受保护分支的名称或部分名称

在下面的例子中，项目 ID 是 5：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches"

下面的示例响应包括：

  • 两个受保护分支，ID 为 100 和 101。
  • push_access_levels 的 ID 为 1001、1002 和 1003。
  • merge_access_levels 的 ID 为 2001 和 2002。
[
  {
    "id": 1,
    "name": "master",
    "push_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "Maintainers"
      },
      {
        "id": 2,
        "access_level": 40,
        "access_level_description": "Deploy key",
        "deploy_key_id": 1
      }
    ],
    "merge_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "Maintainers"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  },
  {
    "id": 1,
    "name": "release/*",
    "push_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "Maintainers"
      }
    ],
    "merge_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "Maintainers"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  },
  ...
]

专业版或旗舰版的用户还可以看到 user_id、group_id 和 inherited 参数。如果 inherited 参数存在，表示该设置是从项目的群组继承的。

下面的示例响应包括：

  • 一个受保护分支，ID 为 100。
  • push_access_levels 的 ID 为 1001、和 1002。
  • merge_access_levels 的 ID 为 2001。
[
  {
    "id": 1,
    "name": "master",
    "push_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "user_id": null,
        "group_id": null,
        "access_level_description": "Maintainers"
      },
      {
        "id": 2,
        "access_level": 40,
        "access_level_description": "Deploy key",
        "deploy_key_id": 1,
        "user_id": null,
        "group_id": null
      }
    ],
    "merge_access_levels": [
      {
        "id":  1,
        "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
  },
  ...
]

获取单个受保护分支或受保护分支通配符

获取单个受保护分支或通配符保护分支。

GET /projects/:id/protected_branches/:name
参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的项目的 ID 或 URL 编码的路径
name string yes 分支或通配符的名称

在下面示例中，项目 ID 是 5，分支名称是 main：

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/protected_branches/main"

响应示例：

{
  "id": 1,
  "name": "master",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "access_level_description": "Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

专业版或旗舰版的用户还可以看到 user_id 和 group_id 参数：

响应示例：

{
  "id": 1,
  "name": "master",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": null,
      "user_id": null,
      "group_id": 1234,
      "access_level_description": "Example Merge Group"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

保护仓库分支

  • deploy_key_id 配置引入于极狐GitLab 17.5。

使用受保护分支通配符保护单个仓库分支或多个项目仓库分支。

POST /projects/:id/protected_branches
参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的项目的 ID 或 URL 编码的路径
name string yes 分支或通配符的名称
push_access_level integer no 允许推送的访问级别（默认值：40，维护者角色）
merge_access_level integer no 允许合并的访问级别（默认值：40，维护者角色）
unprotect_access_level integer no 允许取消保护的访问级别（默认值：40，维护者角色）
allow_force_push boolean no 启用后，可以推送到该分支的成员也可以强制推送（默认：false）
allowed_to_push array no 推送的访问级别数组，每个级别由以下 Hash 格式定义：{user_id: integer}、{group_id: integer} 或 {access_level: integer}
allowed_to_merge array no 合并的访问级别数组，每个级别由以下 Hash 格式定义：{user_id: integer}、{group_id: integer} 或 {access_level: integer}
allowed_to_unprotect array no 取消保护的访问级别数组，每个级别由以下 Hash 格式定义：{user_id: integer}、{group_id: integer} 或 {access_level: integer}
code_owner_approval_required boolean no 如果分支在 CODEOWNERS 文件中，则阻止推送到此分支。（默认值：false）

在下面的示例中，项目 ID 是 5，分支名称是 *-stable。

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40"

示例响应包括：

  • 一个受保护分支，ID 为 101。
  • push_access_levels，ID 为 1001。
  • merge_access_levels，ID 为 2001。
  • unprotect_access_levels，ID 为 3001。
{
  "id": 1,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

专业版或旗舰版的用户还可以看到 user_id 和 group_id 参数：

以下示例响应包括：

  • 一个受保护分支，ID 为 101。
  • push_access_levels，ID 为 1001。
  • merge_access_levels，ID 为 2001。
  • unprotect_access_levels，ID 为 3001。
{
  "id": 1,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": 30,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": 30,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Developers + Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

具有用户/群组级别访问权限的示例

在数组 allowed_to_push / allowed_to_merge / allowed_to_unprotect 中的每一项都应该用这些格式定义：{user_id: integer}， {group_id: integer}，或者 {access_level: integer}。 每个用户都必须有权访问该项目，并且每个组都必须共享该项目。 这些访问级别允许对受保护的分支访问进行更精细的控制。

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1"

一下示例响应包括：

  • 一个受保护分支，ID 为 101。
  • push_access_levels，ID 为 1001。
  • merge_access_levels，ID 为 2001。
  • unprotect_access_levels，ID 为 3001。
{
  "id": 1,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": null,
      "user_id": 1,
      "group_id": null,
      "access_level_description": "Administrator"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  1,
      "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

  • 引入于GitLab 17.5。

在 allowed_to_push 数组中的每一项都应该采用以下格式：{user_id: integer}, {group_id: integer}, {deploy_key_id: integer} 或 {access_level: integer}。必需在您的项目中启用部署 key，而且 key 还必须要具有项目仓库的写权限。有关其他要求，请参阅允许部署 key 推送到受保护的分支。

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"

以下示例响应包括：

  • 一个受保护分支，ID 为 101。
  • push_access_levels，ID 为 1001。
  • merge_access_levels，ID 为 2001。
  • unprotect_access_levels，ID 为 3001。
{
  "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
}

允许推送和允许合并访问的示例

  • 在 13.9 版本中移至专业版。

请求示例：

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

以下示例响应包括：

  • 一个受保护分支，ID 为 105。
  • push_access_levels，ID 为 1001。
  • merge_access_levels，ID 为 2001 和 2002。
  • unprotect_access_levels，ID 为 3001。
{
  "id": 5,
  "name": "master",
  "push_access_levels": [
    {
      "id": 1,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers",
      "user_id": null,
      "group_id": null
    }
  ],
  "merge_access_levels": [
    {
      "id": 1,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers",
      "user_id": null,
      "group_id": null
    },
    {
      "id": 2,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "user_id": null,
      "group_id": null
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "user_id": null,
      "group_id": null
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

取消保护仓库分支

取消保护给定的受保护分支或者受保护分支通配符。

DELETE /projects/:id/protected_branches/:name

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"
参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的项目的 ID 或 URL 编码的路径
name string yes 分支的名称

更新受保护的分支

  • 引入于极狐GitLab 15.6。
  • deploy_key_id 配置引入于极狐GitLab 17.5。

更新受保护的分支。

PATCH /projects/:id/protected_branches/:name
参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的项目 ID 或 URL 编码的路径
name string yes 分支名称或通配符
allow_force_push boolean no 启用后，可以推送到该分支的成员也可以强制推送
code_owner_approval_required boolean no 如果它与 CODEOWNERS 文件中的项目匹配，则阻止推送到该分支。默认为 false
allowed_to_push array no 推送访问级别的数组，每个级别由一个哈希描述，形式为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}
allowed_to_merge array no 合并访问级别的数组，每个级别由一个哈希描述，形式为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}
allowed_to_unprotect array no 非受保护的访问级别的数组，每个级别由一个哈希描述，形式为 {user_id: integer}、{group_id: integer}、{access_level: integer} 或 {id: integer, _destroy: true}，破坏现有访问级别。访问级别 No access 不适用于该字段

allowed_to_push、allowed_to_merge 和 allowed_to_unprotect 数组中的元素应该是 user_id、group_id 或 access_level 之一，形式为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}。

在下面的示例中，项目 ID 为 5，分支名称为 feature-branch。

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch?allow_force_push=true&code_owner_approval_required=true"

在 allowed_to_push、allowed_to_merge 和 allowed_to_unprotect 数组中的元素应该是 user_id、group_id 或 access_level 之一，形式为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}。

allowed_to_push 包括一个额外的元素 deploy_key_id，形式为 {deploy_key_id: integer}。

要更新：

  • user_id：确保更新后的用户有权访问该项目。您还必须在相应的哈希中传递 access_level 的 id。
  • group_id：确保更新的群组已共享此项目。 您还必须在相应的哈希中传递 access_level 的 id。
  • deploy_key_id：确保更新的部署密钥已启用，并且它必须具有对项目存储库的写访问权限。

要删除：

  • 您必须将 _destroy 传递为 true。参见以下示例：

示例：创建 push_access_level 记录 

curl --header 'Content-Type: application/json' --request PATCH \
     --data '{"allowed_to_push": [{"access_level": 40}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/22034114/protected_branches/master"

响应示例：

{
   "name": "master",
   "push_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "Maintainers",
         "user_id": null,
         "group_id": null
      }
   ]
}

示例：更新 push_access_level 记录 

curl --header 'Content-Type: application/json' --request PATCH \
     --data '{"allowed_to_push": [{"id": 12, "access_level": 0}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/22034114/protected_branches/master"

响应示例：

{
   "name": "master",
   "push_access_levels": [
      {
         "id": 12,
         "access_level": 0,
         "access_level_description": "No One",
         "user_id": null,
         "group_id": null
      }
   ]
}

示例：删除 push_access_level 记录 

curl --header 'Content-Type: application/json' --request PATCH \
     --data '{"allowed_to_push": [{"id": 12, "_destroy": true}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/22034114/protected_branches/master"

响应示例：

{
   "name": "master",
   "push_access_levels": []
}

相关主题