Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel1

Get

 

Get a List of Profiles

DescriptionGet a list of profiles

URL

/api/profiles/list

HTTP MethodGET
Response Formatsjson

Security

None
Available sinceVersion 3.3

Examples

Response Format

Code Block
titleJSON
languagejavascript
[
  {
    "name":"Sonar way with Findbugs",
    "language":"java",
    "default":false
  },
  {
    "name":"Sonar way",
    "language":"java",
    "default":false
  },
  ...
]

Parameters

Parameter

Description

Required

Default Value

Example Value

language

Profile language

No

None

java

project

Project key or id

No

None

org.codehaus.sonar:sonar

format

Response format can be set through:

  • Parameter format: json
  • Or the 'Accept' property in the HTTP header:
  • Accept:application/json

If nothing is set, json is used.

NoNonejson

Get Coding Rules Activated in a Quality Profile

...

Code Block
titleJSON
languagejavascript
{
  "backup":
  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
   <!-- Generated by Sonar -->
   <profile>
     <name>Sonar for Sonar</name>
     <language>java</language>
     <rules>
       <rule>
         <repositoryKey>checkstyle</repositoryKey>
         <key>com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck_1296413157</key>
         <priority>INFO</priority>
         <parameters>
           <parameter>
             <key>format</key><value>TODO</value>
          </parameter>
        </parameters>
      </rule>
      ...
    </rules>
    <alerts>
      <alert>
        <metric>blocker_violations</metric>
        <operator>&gt;</operator>
        <warning></warning>
        <error>0</error>
      </alert>
      ...
    </alerts>
  </profile>"
}

Parameters

Parameter

Description

Required

Default Value

Example Value

language

Project language

Yes

None

java

name

Profile name. If not set, the default profile for the selected language is used.

No

None

Sonar%20way

format

Response format can be set through:

  • Parameter format: xml | json
  • Or the 'Accept' property in the HTTP header:
    • Accept:text/xml
    • Accept:application/json
If nothing is set, json is used.
NoNonejson

...