How to extract or export rules from SonarQube

Question

Appriciate if I can get help for the below scenario. My issues to identify how to extract/export all java rules on SonarQube 4.5.7. I tried the below two API calls but I get a "The page you were looking for doesn't exist".

The sonarqube version I have shows 781 java rules my objective is to extract them to an excel or a csv file

[1]curl -X GET -v -u admin:admin http://localhost:9000/api/rules?language=java

[2]curl -X GET -v -u admin:admin http://localhost:9000/api/rules/search?languages=java >> java.json

The second option seems to generate an output but not all 781 rules are extracted thanks,shavantha

score 11 · Answer 1 · answered Nov 30 '16 at 12:48

11

URL api/rules/search?languages=java is the correct way to get all Java rules. Response is paginated, so only 10 rules are returned by default :

{ "total": 781, "p": 1, "ps": 10, "rules": [ <here are 10 rules ] }

Use pagination parameter p (page index) for traversing all results. Note that the page size can be changed with parameter ps (defaults 10).

answered Nov 30 '16 at 12:48

Simon Brandhof

5,137
1
21
28

thank you it worked. I used REST client on add-on on firefox and extracted the details as : http://localhost:9000/api/rules/search?language=java&p=2&ps=100 – shavantha Dec 05 '16 at 11:22

score 5 · Answer 2 · answered Jun 23 '20 at 12:42

5

Login as an Admin

then go to the Quality Profiles section

click which language rule set you want to copy

click on the settings like button at the side

then select copy and give a name to the copy

then in the next page click on the settings like button then click backup

your file will be exported in to your local in the XML format

Applicable for both Internet Sonar as well as Local

answered Jun 23 '20 at 12:42

Vignesh Ravichandran

169
3
10

The real answer. Any way to upload the xml to another Sonar instance? – Brandon Dyer Jan 11 '21 at 14:42
Sorry, I haven't tried that one.., if you have done pls post that one.., – Vignesh Ravichandran Jan 28 '21 at 09:09
@BrandonDyer yes, similarly you can login as admin and go tot Quality Profile. There are 2 buttons on top right side, Create & Restore. The XML file generated in previous step(from other or same SQ instance) can be uploaded using Restore button. – TusharK Dec 09 '21 at 08:40
Thanks @VigneshRavichandran , for this solution I was able to export all profiles. – Tanvi Agarwal Jun 23 '22 at 10:07
Thanks @TusharK , thanks for the method to restore. It worked for me and I could update my Sonar – Tanvi Agarwal Jun 23 '22 at 10:08

score 2 · Answer 3 · answered Jul 05 '17 at 09:23

2

http://localhost:9000/api/rules/search?languages=java

the url parameter is languages rather language

answered Jul 05 '17 at 09:23

java1977

398
4
12
25

How to extract or export rules from SonarQube

3 Answers3

Linked