GIgitlab
branches

Retrieve a repository branch

Retrieves a specified project repository branch.

get/api/v4/projects/{id}/repository/branches/{branch}

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project

branchstring required

The name of the branch

Response

Retrieve a repository branch

namestring required
mergedboolean required
protectedboolean required
developers_can_pushboolean required
developers_can_mergeboolean required
can_pushboolean required
defaultboolean required
web_urlstring required

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.