(Self-Hosted SonarQube Developer Edition 9.9 LTA) As our team is in the phase of automating a few things with SonarQube we started looking at the WebAPI v2. To our surprise there seems to be some crucial information that is not available in the API. Questions below: Where is the OpenAPI specifica…

This ticket mentioned that there is a OpenAPI specification on Next . Not sure how it relates to the current WebAPI v2. We are on 9.9, so it could be that it is available with 10.x unless it’s new for Next. What is Next - next minor or major version?

Hi Jimisola, Have you tried this via the UI? The best way to master the API is to perform the desired action via the UI and eavesdrop to see which calls the UI made to accomplish the action. You may also find this guide helpful. Regarding an OpenAPI specification, I’m not sure one exists yet. The…

Hi Ann, Thank you for that information. I managed to find the project key by eavesdropping. Sadly, I can’t seem to find the url to the git repo in SonarQube other than for pull requests. Can this really be? I never actually realized that there isn’t a “click here to get to git repository” is the…

Hi, Once you tell us why you need the data, we can consider this your feature request and I’ll forward it to the Project Managers. :slight_smile: Ann

We need the data because it’s a way (only?) to link a SonarQube project with a SCM project (here: GitLab) unless you use the SonarQube project key. We want to automate our CI/CD even more and set project key and project token automatically in the pipeline. Hence, remove the need for setting sonar-pr…

Hi, Thanks for this detail. But I still don’t understand why you want to know the repo from the SonarQube side. Everything you’ve talked about here is from the CI side / project side where you presumably already know the repo…? Thx, Ann

Ok. I’ll try again. Maybe I missed an easier solution. How would you match a GitLab project (without any SonarQube information) to a SonarQube project using the SonarQube API? Keep in mind that the pipeline runs for a GitLab repository and now needs to figure out which SonarQube project it matches…

Hi, Well, I would look in the project itself: the Maven or Gradle build files, which should hold project ID the pipeline script which may add the ID on the command line, e.g. for .NET projects sonar-project.properties [image] Jimisola Laursen: a GitLab project (without any SonarQube informat…

Hi Ann, Yes, one can look in Maven or Gradle files, package.json, pyproject.toml, Dockerfile etc. We don’t want such a solution but one that works with a git repository irrespective of it’s content. We are trying to get ride of the sonar-project.properties all in all. We want a configuration less…

Hi Jimisola, Thanks for sharing. You can choose to pass the sonar.links.scm parameter. If you supply it, I believe it’s displayed on the Project Information tab, so you can use your browser’s Developer Tools to spy on the call the UI makes to know how to retrieve the information. Ann

SonarQube WebAPI v2 - OpenAPI specification, various questions regarding information etc

SonarQube Server / Community Build

lfvjimisola (Jimisola Laursen) May 20, 2024, 8:28am 19

Sure. I created a new topic: Bug report: Web API endpoint search_gitlab_repos lists old component data instead of new

Topic		Replies	Views
Rest API - get git repository name of sonar project SonarQube Server / Community Build	3	1341	August 1, 2022
Bug report: Web API endpoint search_gitlab_repos lists old component data instead of new SonarQube Server / Community Build	27	601	September 18, 2025
New project creation + v2 APIs SonarQube Cloud	12	1194	March 23, 2025
Jenkins Master and GitLab Repository information Required from SonarQube SonarQube Server / Community Build sonarqube , scanner	1	738	October 7, 2022
Fetch SonarQube Report from java project using SonarQube rest API SonarQube Server / Community Build sonarqube , web_api	3	1617	January 31, 2022

SonarQube WebAPI v2 - OpenAPI specification, various questions regarding information etc

Related topics