Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<div><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0xfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=1"></p></td></tr></table><div><h1>Get a List of Profiles</h1></div><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Get a list of profiles</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/profiles/list</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Response Formats</strong></td><td colspan="1" class="confluenceTd">json</td></tr><tr><td class="confluenceTd"><p><strong>Security</strong></p></td><td class="confluenceTd">None</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Available since</strong></td><td colspan="1" class="confluenceTd">Sonar 3.3</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Use Case</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Example Request</span></p></th></tr><tr><td class="confluenceTd"><p>Get all the profiles</p></td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/profiles?language=java">http://nemo.sonarsource.org/api/profiles/</a><a href="http://nemo.sonarsource.org/api/profiles/list">list</a></p></blockquote></td></tr><tr><td class="confluenceTd"><span>Get all the java profiles</span></td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/profiles/list?language=java">http://nemo.sonarsource.org/api/profiles/list?language=java</a></p></blockquote></td></tr><tr><td class="confluenceTd"><span>Get all the profiles used by project org.codehaus.sonar:sonar</span></td><td class="confluenceTd"><blockquote><p><span>GET </span><a href="http://nemo.sonarsource.org/api/profiles/list?project=org.codehaus.sonar:sonar">http://nemo.sonarsource.org/api/profiles/list?project=org.codehaus.sonar:sonar</a></p></blockquote></td></tr><tr><td colspan="1" class="confluenceTd"><span>Get the java profile used by project org.codehaus.sonar:sonar</span></td><td colspan="1" class="confluenceTd"><blockquote><p><span>GET </span><a href="http://nemo.sonarsource.org/api/profiles/list?project=org.codehaus.sonar:sonar&amp;language=java">http://nemo.sonarsource.org/api/profiles/list?project=org.codehaus.sonar:sonar&amp;language=java</a></p></blockquote></td></tr></tbody></table><h3>Response Format</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=javascript|title=JSON" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9SlNPTnxsYW5ndWFnZT1qYXZhc2NyaXB0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>[
  {
    "name":"Sonar way with Findbugs",
    "language":"java",
    "default":false
  },
  {
    "name":"Sonar way",
    "language":"java",
    "default":false
  },
  ...
]</pre></td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th class="confluenceTh"><p>Example Value</p></th></tr><tr><td class="confluenceTd"><p><strong>language</strong></p></td><td class="confluenceTd"><p>Profile language</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>java</p></td></tr><tr><td class="confluenceTd"><p><strong>project</strong></p></td><td class="confluenceTd"><p>Project key or id</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>org.codehaus.sonar:sonar</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>format</strong></td><td colspan="1" class="confluenceTd"><p>Response format can be set through:</p><ul><li>Parameter format: json</li><li>Or the 'Accept' property in the HTTP header:</li></ul><ul><li style="list-style-type: none;"><ul><li>Accept:application/json</li></ul></li></ul><div>If nothing is set, json is used.</div></td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table><h1>Get Coding Rules Activated in a Quality Profile</h1></div><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Get the list of coding rules activated in a quality profile</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/profiles</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Response Formats</strong></td><td colspan="1" class="confluenceTd">json | xml</td></tr><tr><td class="confluenceTd"><p><strong>Security</strong></p></td><td class="confluenceTd">None</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Get all the coding rules activated on the default java quality profile</td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/profiles?language=java">http://nemo.sonarsource.org/api/profiles?language=java</a></p></blockquote></td></tr><tr><td class="confluenceTd">Get all the coding rules activated on the java quality profile 'Common rules'</td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/profiles?language=java&amp;name=Common%20rules">http://nemo.sonarsource.org/api/profiles?language=java&amp;name=Common%20rules</a></p></blockquote></td></tr></tbody></table><h3>Response Format</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=javascript|title=JSON" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9SlNPTnxsYW5ndWFnZT1qYXZhc2NyaXB0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>[
  {
    "name":"Nemo rules with findbugs",
    "language":"java",
    "parent":"Common rules",
    "default":true,
    "provided":false,
    "rules":[
      {
        "key":"UnnecessaryParentheses",
        "repo":"pmd",
        "severity":"MAJOR"
      },
      {
        "key":"UncommentedEmptyMethod",
        "repo":"pmd","severity":"INFO"
      },
      ...
  }
]</pre></td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th class="confluenceTh"><p>Example Value</p></th></tr><tr><td class="confluenceTd"><p><strong>language</strong></p></td><td class="confluenceTd"><p>Project language</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>java</p></td></tr><tr><td class="confluenceTd"><p><strong>name</strong></p></td><td class="confluenceTd"><p>Profile name. If not set, the default profile for the selected language is used.</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>Sonar%20way</p></td></tr><tr><td class="confluenceTd"><p><strong>rule_repositories</strong></p></td><td class="confluenceTd"><p>Comma-separated list of rules repository keys.</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>pmd,findbugs</p></td></tr><tr><td class="confluenceTd"><p><strong>rule_severities</strong></p></td><td class="confluenceTd"><p>Comma-separated list of rule severities.<br />Possible values: BLOCKER | CRITICAL <span>|</span> MAJOR <span>|</span> MINOR <span>|</span> INFO.</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>BLOCKER,CRITICAL</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>format</strong></td><td colspan="1" class="confluenceTd"><p>Response format can be set through:</p><ul><li>Parameter format: xml | json</li><li>Or the 'Accept' property in the HTTP header:</li></ul><ul><li><ul><li>Accept:text/xml</li><li>Accept:application/json</li></ul></li></ul><div>If nothing is set, json is used.</div></td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table><h1>Backup a Quality Profile</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Backup a quality profile</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/profiles/backup</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Response Formats</strong></td><td colspan="1" class="confluenceTd">json | xml</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p>Requires Global Administrator role</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>Available since</strong></td><td colspan="1" class="confluenceTd">Sonar 3.1</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Backup the default java quality profile</td><td class="confluenceTd"><blockquote><p>GET <a href="http://localhost:9000/api/profiles/backup?language=java">http://localhost:9000/api/profiles/backup?language=java</a></p></blockquote></td></tr><tr><td class="confluenceTd">Backup the java quality profile 'Sonar%20way'</td><td class="confluenceTd"><blockquote><p>GET <a href="http://localhost:9000/api/profiles/backup?language=java&amp;name=Sonar%20way">http://localhost:9000/api/profiles/backup?language=java&amp;name=Sonar%20way</a></p></blockquote></td></tr></tbody></table><h3>Response Format</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=javascript|title=JSON" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9SlNPTnxsYW5ndWFnZT1qYXZhc2NyaXB0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>{
  "backup":
  "&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?>
   &lt;!-- Generated by Sonar -->
   &lt;profile>
     &lt;name>Sonar for Sonar&lt;/name>
     &lt;language>java&lt;/language>
     &lt;rules>
       &lt;rule>
         &lt;repositoryKey>checkstyle&lt;/repositoryKey>
         &lt;key>com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck_1296413157&lt;/key>
         &lt;priority>INFO&lt;/priority>
         &lt;parameters>
           &lt;parameter>
             &lt;key>format&lt;/key>&lt;value>TODO&lt;/value>
          &lt;/parameter>
        &lt;/parameters>
      &lt;/rule>
      ...
    &lt;/rules>
    &lt;alerts>
      &lt;alert>
        &lt;metric>blocker_violations&lt;/metric>
        &lt;operator>&amp;gt;&lt;/operator>
        &lt;warning>&lt;/warning>
        &lt;error>0&lt;/error>
      &lt;/alert>
      ...
    &lt;/alerts>
  &lt;/profile>"
}</pre></td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th class="confluenceTh"><p>Example Value</p></th></tr><tr><td class="confluenceTd"><p><strong>language</strong></p></td><td class="confluenceTd"><p>Project language</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>java</p></td></tr><tr><td class="confluenceTd"><p><strong>name</strong></p></td><td class="confluenceTd"><p>Profile name. If not set, the default profile for the selected language is used.</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>Sonar%20way</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>format</strong></td><td colspan="1" class="confluenceTd"><p>Response format can be set through:</p><ul><li>Parameter format: xml | json</li><li>Or the 'Accept' property in the HTTP header:</li></ul><ul><li><ul><li>Accept:text/xml</li><li>Accept:application/json</li></ul></li></ul><div>If nothing is set, json is used.</div></td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table><h1>Restore a Quality Profile Backup</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Restore a quality profile backup</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/profiles/restore</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">POST</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p>Requires Global Administrator role</p></td></tr><tr><td class="confluenceTd"><strong>Available since</strong></td><td class="confluenceTd">Sonar 3.1</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Restore a quality profile from a backup</td><td class="confluenceTd"><blockquote><p>curl -X POST -u admin:admin -F 'backup=@backup.com' -v http://localhost:9000/api/profiles/restore</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th></tr><tr><td class="confluenceTd"><p><strong>backup</strong></p></td><td class="confluenceTd"><p>Path to the file containing the backup (HTML format)</p></td><td class="confluenceTd"><p>Yes</p></td></tr></tbody></table><h1>Delete a Quality Profile</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Delete a quality profile</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/profiles/destroy</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">POST</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p>Requires Global Administrator role</p></td></tr><tr><td class="confluenceTd"><strong>Available since</strong></td><td class="confluenceTd">Sonar 3.3</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Delete the java quality profile 'Sonar way'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;<span>language=java&amp;name=Sonar way</span>&quot; <span>-X POST </span><span class="nolink">http://localhost:9000/api/profiles/destroy</span></p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>language</strong></p></td><td class="confluenceTd"><p>Profile language</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">java</td></tr><tr><td colspan="1" class="confluenceTd"><strong>name</strong></td><td colspan="1" class="confluenceTd">Profile name</td><td colspan="1" class="confluenceTd">Yes</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">Sonar way</td></tr></tbody></table><h1>Set a Quality Profile as Default</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Delete a quality profile</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/profiles/set_as_default</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">POST</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p>Requires Global Administrator role</p></td></tr><tr><td class="confluenceTd"><strong>Available since</strong></td><td class="confluenceTd">Sonar 3.3</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Set the java quality profile 'Sonar way' as default</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;language=java&amp;name=Sonar way&quot; -X POST <span class="nolink"><span class="nolink">http://localhost:9000/api/profiles/set_as_default</span></span></p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>language</strong></p></td><td class="confluenceTd"><p>Profile language</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">java</td></tr><tr><td colspan="1" class="confluenceTd"><strong>name</strong></td><td colspan="1" class="confluenceTd">Profile name</td><td colspan="1" class="confluenceTd">Yes</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">Sonar way</td></tr></tbody></table>