How to retrieve branch information by the API from a SonarQube project?

Question

I'm using SonarQube branch plugin (1.0 (build 507)) and want to retrieve information from branches. My SonarQube version is 6.7.

The SonarQube project (PC_civil-affairs) has three branches, master (main), develop, feature_branch. These are all long-lived branches.

The next calls retrieve information from the master branch https://website.com/sonar/api/project_analyses/search?project=PC_civil-affairs https://website.com/sonar/api/settings/values?component=PC_civil-affairs&keys=sonar.leak.period https://website.com/sonar/api/qualitygates/project_status?projectKey=PC_civil-affairs

How should I adjust the above calls to retrieve the same information from the develop and feature_branch?

score 2 · Accepted Answer · answered Jun 15 '18 at 11:54

I tested the following solutions on SonarQube 7.1.

project_analyses/search

You have to add the branch parameter. Example:

https://website.com/sonar/api/project_analyses/search?project=PC_civil-affairs&branch=xyz

settings/values

Settings are the same for all branches, so your URL is correct:

https://website.com/sonar/api/settings/values?component=PC_civil-affairs&keys=sonar.leak.period

qualitygates/project_status

Unfortunately, I didn't find any way to get quality gate status.

thnx! found that this webservice description is available when i press "Show internal API". — dj van kessel, Jun 16 '18 at 05:27

score 2 · Answer 2 · answered Sep 11 '19 at 21:59

The branches list endpoint exists, with quality gate statuses for each branch: https://website.com/sonar/api/project_branches/list?project=$projectKey. It gives a reponse example like:

  {
    "branches": [
    {
      "name": "feature/foo",
      "isMain": false,
      "type": "SHORT",
      "mergeBranch": "master",
      "status": {
        "qualityGateStatus": "OK",
        "bugs": 1,
        "vulnerabilities": 0,
        "codeSmells": 0
      },
      "analysisDate": "2017-04-03T13:37:00+0100"
    },
    {
      "name": "master",
      "isMain": true,
      "type": "LONG",
      "status": {
        "qualityGateStatus": "ERROR"
      },
      "analysisDate": "2017-04-01T01:15:42+0100"
    }
  ]
}

If you are looking for a specific branch's status, you could pipe it into a tool like jq, and filter with something like:

| jq '.branches | .[] | {name: .name, status: .status.qualityGateStatus} | select(.name=="master") | .status'

And this should return "ERROR" for the master branch status.

score 0 · Answer 3 · answered Apr 11 '22 at 15:37

qualitygates/project_status

You can get the quality gate status of your branch when you use the following URL replacing MyBranch with your branch name:

https://website.com/sonar/api/qualitygates/project_status?branch=MyBranch&projectKey=PC_civil-affairs

How to retrieve branch information by the API from a SonarQube project?

3 Answers3