Branches API

The Branches REST API will obtain list of branches associated to a Jira issue.

Gets a set of branches from Jira issue based on the associated commit links

Url

{JiraBaseURL}/rest/gitplugin/1.0/issues/branches?key={issuekey}

Method

GET

Parameters

Response

If the optional query is not defined, it will return ALL indexed git branches. For example: {JiraBaseURL}/rest/gitplugin/1.0/issues/branches

Example

http://jira.yourorg.com/rest/gitplugin/1.0/issues/branches?key=TEST-435

Result:
{
    "success":true,
    "branches":["master","release","TEST-435"]
}

Get the list of branches bound to an issue

A different request is used to retrieve branches on the “issue” page. It includes branches whose name is associated with the issue key.

Url

{JIRA_BASE_URL}/rest/gitplugin/1.0/issuegitdetails/issue/{ISSUE_KEY}

Method

GET

Parameters

Response

It includes branches whose name is associated with the issue. The result will show the branches on which commits exist in the specified Jira issue. It’s a set of branches to which the commits are bound to the issue they are associated with. They can be viewed in the the Git Commits tab.

Example

https://jira.yourorg.com/rest/gitplugin/1.0/issuegitdetails/issue/TEST-435

Result:
{
    "commitCount": 53,
    "repositories":[
        {
            "repoId": 12718,
            "repoName": "test-repo",
            "isGitViewerEnabled": true,
            "isRepoApiEnabled": true,
            "branches":[
                {
                    "name": "TEST-435-branch-001",
                    "gkBranchUrl": "gitkraken://repolink/d5407d...4a03c/branch/TEST-435-branch-001?url=https%3A%2F%2Fgithub.com%2FWilyCoyote%2Ftest-repo.git",
                    "glBranchUrl": "vscode://eamodio.gitlens/link/r/d5407d...4a03c/b/TEST-435-branch-001?url=https%3A%2F%2Fgithub.com%2FWilyCoyote%2Ftest-repo.git",
                    "isAheadBehindPresented": true,
                    "ahead": 2,
                    "behind": 6448,
                    "externalUrl": "https://github.com/WilyCoyote/test-repo/tree/TEST-435-branch-001"
                },
                {
                    "name": "TEST-435-branch-002",
                    "gkBranchUrl": "gitkraken://repolink/d5407d...4a03c/branch/TEST-435-branch-002?url=https%3A%2F%2Fgithub.com%2FWilyCoyote%2Ftest-repo.git",
                    "glBranchUrl": "vscode://eamodio.gitlens/link/r/d5407d...4a03c/b/GIT-4932?url=https%3A%2F%2Fgithub.com%2FWilyCoyote%2Ftest-repo.git",
                    "isAheadBehindPresented": true,
                    "ahead": 0,
                    "behind": 6379,
                    "externalUrl": "https://github.com/WilyCoyote/test-repo/tree/TEST-435-branch-002"
                }
            ]
        }
    ],
    "enableBranchCreation": true,
    "gkEnabled": true,
    "glEnabled": true,
    "notAllPermissions": false
}

I made the correct request but I don’t see the expected branches in the results?

If the issue displays these branches while the request does not, the likely explanation is that, the request is being executed by a user who lacks sufficient permissions to access the repository. (See the yellow infobox above.)

For a quick check, it is possible to omit the issue key in the request.

It will look like this: https://jira.your-org.com/rest/gitplugin/1.0/issues/branches

When a user is granted specific permissions, they will receive a json response that shows various branches.

« Back to: REST API index