2017-09-10 17:25:29 +05:30
|
|
|
# Protected branches API
|
|
|
|
|
|
|
|
>**Note:** This feature was introduced in GitLab 9.5
|
|
|
|
|
|
|
|
**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:
|
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
|
2017-09-10 17:25:29 +05:30
|
|
|
```
|
|
|
|
|
|
|
|
## List protected branches
|
|
|
|
|
|
|
|
Gets a list of protected branches from a project.
|
|
|
|
|
|
|
|
```
|
|
|
|
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 |
|
|
|
|
|
|
|
|
```bash
|
2019-02-13 22:33:31 +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
|
|
|
|
[
|
|
|
|
{
|
|
|
|
"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
|
|
|
}
|
|
|
|
]
|
|
|
|
},
|
|
|
|
...
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
|
|
|
## Get a single protected branch or wildcard protected branch
|
|
|
|
|
|
|
|
Gets a single protected branch or wildcard protected branch.
|
|
|
|
|
|
|
|
```
|
|
|
|
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 |
|
|
|
|
|
|
|
|
```bash
|
2019-02-13 22:33:31 +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
|
|
|
|
{
|
|
|
|
"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
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Protect repository branches
|
|
|
|
|
|
|
|
Protects a single repository branch or several project repository
|
|
|
|
branches using a wildcard protected branch.
|
|
|
|
|
|
|
|
```
|
|
|
|
POST /projects/:id/protected_branches
|
|
|
|
```
|
|
|
|
|
|
|
|
```bash
|
2019-02-13 22:33:31 +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'
|
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 or wildcard |
|
2018-11-08 19:23:39 +05:30
|
|
|
| `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) |
|
2017-09-10 17:25:29 +05:30
|
|
|
|
|
|
|
Example response:
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"name": "*-stable",
|
|
|
|
"push_access_levels": [
|
|
|
|
{
|
|
|
|
"access_level": 30,
|
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,
|
2018-11-08 19:23:39 +05:30
|
|
|
"access_level_description": "Developers + Maintainers"
|
2017-09-10 17:25:29 +05:30
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Unprotect repository branches
|
|
|
|
|
|
|
|
Unprotects the given protected branch or wildcard protected branch.
|
|
|
|
|
|
|
|
```
|
|
|
|
DELETE /projects/:id/protected_branches/:name
|
|
|
|
```
|
|
|
|
|
|
|
|
```bash
|
2019-02-13 22:33:31 +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 |
|