debian-mirror-gitlab/doc/api/protected_branches.md

332 lines
9.6 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Create
group: Source Code
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers"
type: reference, api
---
2017-09-10 17:25:29 +05:30
# Protected branches API
2020-10-24 23:57:45 +05:30
> Introduced in GitLab 9.5.
2017-09-10 17:25:29 +05:30
**Valid access levels**
2018-12-05 23:21:45 +05:30
The access levels are defined in the `ProtectedRefAccess.allowed_access_levels` method. Currently, these levels are recognized:
2019-07-07 11:18:12 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
0 => No access
30 => Developer access
2018-11-08 19:23:39 +05:30
40 => Maintainer access
2019-09-30 21:07:59 +05:30
60 => Admin access
2017-09-10 17:25:29 +05:30
```
## List protected branches
Gets a list of protected branches from a project.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /projects/:id/protected_branches
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2020-03-13 15:44:24 +05:30
| `search` | string | no | Name or part of the name of protected branches to be searched for |
2017-09-10 17:25:29 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches"
2017-09-10 17:25:29 +05:30
```
Example response:
```json
[
{
2020-03-13 15:44:24 +05:30
"id": 1,
2017-09-10 17:25:29 +05:30
"name": "master",
"push_access_levels": [
{
"access_level": 40,
2018-11-08 19:23:39 +05:30
"access_level_description": "Maintainers"
2017-09-10 17:25:29 +05:30
}
],
"merge_access_levels": [
{
"access_level": 40,
2018-11-08 19:23:39 +05:30
"access_level_description": "Maintainers"
2017-09-10 17:25:29 +05:30
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2017-09-10 17:25:29 +05:30
},
...
]
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `user_id` and `group_id` parameters:
Example response:
```json
[
{
2020-03-13 15:44:24 +05:30
"id": 1,
2019-09-30 21:07:59 +05:30
"name": "master",
"push_access_levels": [
{
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
}
],
"merge_access_levels": [
{
"access_level": null,
"user_id": null,
"group_id": 1234,
"access_level_description": "Example Merge Group"
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2019-09-30 21:07:59 +05:30
},
...
]
```
2017-09-10 17:25:29 +05:30
## Get a single protected branch or wildcard protected branch
Gets a single protected branch or wildcard protected branch.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /projects/:id/protected_branches/:name
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `name` | string | yes | The name of the branch or wildcard |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/master"
2017-09-10 17:25:29 +05:30
```
Example response:
```json
{
2020-03-13 15:44:24 +05:30
"id": 1,
2017-09-10 17:25:29 +05:30
"name": "master",
"push_access_levels": [
{
"access_level": 40,
2018-11-08 19:23:39 +05:30
"access_level_description": "Maintainers"
2017-09-10 17:25:29 +05:30
}
],
"merge_access_levels": [
{
"access_level": 40,
2018-11-08 19:23:39 +05:30
"access_level_description": "Maintainers"
2017-09-10 17:25:29 +05:30
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2017-09-10 17:25:29 +05:30
}
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `user_id` and `group_id` parameters:
Example response:
```json
{
2020-03-13 15:44:24 +05:30
"id": 1,
2019-09-30 21:07:59 +05:30
"name": "master",
"push_access_levels": [
{
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
}
],
"merge_access_levels": [
{
"access_level": null,
"user_id": null,
"group_id": 1234,
"access_level_description": "Example Merge Group"
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2019-09-30 21:07:59 +05:30
}
```
2017-09-10 17:25:29 +05:30
## Protect repository branches
Protects a single repository branch or several project repository
branches using a wildcard protected branch.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
POST /projects/:id/protected_branches
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
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"
2017-09-10 17:25:29 +05:30
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2019-12-21 20:55:43 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `name` | string | yes | The name of the branch or wildcard |
| `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) |
| `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) |
| `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) |
| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash |
| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash |
| `allowed_to_unprotect` | array | no | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash |
| `code_owner_approval_required` | boolean | no | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the [`CODEOWNERS` file](../user/project/code_owners.md). (defaults: false) |
2019-09-30 21:07:59 +05:30
Example response:
```json
{
2020-03-13 15:44:24 +05:30
"id": 1,
2019-09-30 21:07:59 +05:30
"name": "*-stable",
"push_access_levels": [
{
"access_level": 30,
"access_level_description": "Developers + Maintainers"
}
],
"merge_access_levels": [
{
"access_level": 30,
"access_level_description": "Developers + Maintainers"
2019-12-04 20:38:33 +05:30
}
2019-09-30 21:07:59 +05:30
],
"unprotect_access_levels": [
{
"access_level": 40,
"access_level_description": "Maintainers"
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2019-09-30 21:07:59 +05:30
}
```
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `user_id` and `group_id` parameters:
2017-09-10 17:25:29 +05:30
Example response:
```json
{
2020-03-13 15:44:24 +05:30
"id": 1,
2017-09-10 17:25:29 +05:30
"name": "*-stable",
"push_access_levels": [
{
"access_level": 30,
2019-09-30 21:07:59 +05:30
"user_id": null,
"group_id": null,
2018-11-08 19:23:39 +05:30
"access_level_description": "Developers + Maintainers"
2017-09-10 17:25:29 +05:30
}
],
"merge_access_levels": [
{
"access_level": 30,
2019-09-30 21:07:59 +05:30
"user_id": null,
"group_id": null,
2018-11-08 19:23:39 +05:30
"access_level_description": "Developers + Maintainers"
2019-12-04 20:38:33 +05:30
}
2019-09-30 21:07:59 +05:30
],
"unprotect_access_levels": [
{
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2019-09-30 21:07:59 +05:30
}
```
### Example with user / group level access **(STARTER)**
Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the
2020-10-04 03:57:07 +05:30
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](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE.
2019-09-30 21:07:59 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
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"
2019-09-30 21:07:59 +05:30
```
Example response:
```json
{
2020-03-13 15:44:24 +05:30
"id": 1,
2019-12-04 20:38:33 +05:30
"name": "*-stable",
2019-09-30 21:07:59 +05:30
"push_access_levels": [
{
2019-12-04 20:38:33 +05:30
"access_level": null,
"user_id": 1,
"group_id": null,
"access_level_description": "Administrator"
2019-09-30 21:07:59 +05:30
}
],
"merge_access_levels": [
{
2019-12-04 20:38:33 +05:30
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
2019-09-30 21:07:59 +05:30
}
],
"unprotect_access_levels": [
{
2019-12-04 20:38:33 +05:30
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
2017-09-10 17:25:29 +05:30
}
2019-12-21 20:55:43 +05:30
],
"code_owner_approval_required": "false"
2017-09-10 17:25:29 +05:30
}
```
## Unprotect repository branches
Unprotects the given protected branch or wildcard protected branch.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
DELETE /projects/:id/protected_branches/:name
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"
2017-09-10 17:25:29 +05:30
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `name` | string | yes | The name of the branch |
2019-12-21 20:55:43 +05:30
## Require code owner approvals for a single branch
Update the "code owner approval required" option for the given protected branch protected branch.
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-21 20:55:43 +05:30
PATCH /projects/:id/protected_branches/:name
```
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch"
2019-12-21 20:55:43 +05:30
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `name` | string | yes | The name of the branch |
| `code_owner_approval_required` | boolean | no | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the [`CODEOWNERS` file](../user/project/code_owners.md). (defaults: false)|