Skip to content
forgit api docs

Protect a single branch

PUT
/api/v4/projects/{id}/repository/branches/{branch}/protect

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
One of:
string

The ID or URL-encoded path of the project

branch
required
string

The name of the branch

Request Body

Section titled “ Request Body ”
Media type application/json
object
developers_can_push

Flag if developers can push to that branch

boolean
nullable
developers_can_merge

Flag if developers can merge to that branch

boolean
nullable
Example generated 
{
  "developers_can_push": true,
  "developers_can_merge": true
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
name
string
commit
object
id
string
short_id
string
created_at
string format: date-time
parent_ids
Array<string>
title
string
message
string
author_name
string
author_email
string
authored_date
string format: date-time
committer_name
string
committer_email
string
committed_date
string format: date-time
trailers
object
extended_trailers
object
web_url
string
merged
boolean
protected
boolean
developers_can_push
boolean
developers_can_merge
boolean
can_push
boolean
default
boolean
web_url
string
Example 
{
  "name": "master",
  "commit": {
    "id": "2695effb5807a22ff3d138d593fd856244e155e7",
    "short_id": "2695effb",
    "created_at": "2017-07-26T11:08:53.000+02:00",
    "parent_ids": [
      "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
    ],
    "title": "Initial commit",
    "message": "Initial commit",
    "author_name": "John Smith",
    "author_email": "john@example.com",
    "authored_date": "2012-05-28T04:42:42-07:00",
    "committer_name": "Jack Smith",
    "committer_email": "jack@example.com",
    "committed_date": "2012-05-28T04:42:42-07:00",
    "trailers": {
      "Merged-By": "Jane Doe janedoe@gitlab.com"
    },
    "extended_trailers": {
      "Signed-off-by": [
        "John Doe <johndoe@gitlab.com>",
        "Jane Doe <janedoe@gitlab.com>"
      ]
    },
    "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
  },
  "merged": true,
  "protected": true,
  "developers_can_push": true,
  "developers_can_merge": true,
  "can_push": true,
  "default": true,
  "web_url": "https://gitlab.example.com/Commit921/the-dude/-/tree/master"
}

400

Section titled “ 400 ”

Bad Request

404

Section titled “ 404 ”

404 Branch Not Found