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.

<table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Get a list of rules</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/rules</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 | csv</td></tr><tr><td class="confluenceTd"><p><strong>Security</strong></p></td><td class="confluenceTd"><p>None</p></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 java rules</td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/rules?language=java">http://nemo.sonarsource.org/api/rules?language=java</a></p></blockquote></td></tr><tr><td class="confluenceTd">Get all the java rules from pmd and findbugs</td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/rules?language=java&amp;plugin=pmd,findbugs">http://nemo.sonarsource.org/api/rules?language=java&amp;plugin=pmd,findbugs</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>[
  {
    "title":"@deprecated Tag",
    "key":"checkstyle:com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck_1296413307",
    "plugin":"checkstyle",
    "config_key":"Checker/TreeWalker/TodoComment",
    "description":"",
    "priority":"INFO",
    "params":[
      {
        "name":"format",
        "description":"Regular expression pattern to check. Default is TODO:"
      }
    ]
  },
  ...
]</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>Key of the language</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd">java</td></tr><tr><td class="confluenceTd"><p><strong>plugin</strong></p></td><td class="confluenceTd"><p>Comma-separated list of rules plugins</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>findbugs,pmd</p></td></tr><tr><td class="confluenceTd"><p><strong>searchtext</strong></p></td><td class="confluenceTd"><p>To filter on rules containing a specified text in their name, key or title</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>braces</p></td></tr><tr><td class="confluenceTd"><p><strong>profile</strong></p></td><td class="confluenceTd"><p>When this parameter is defined, a node 'status' is added for each 'rule' node with values 'INACTIVE' or 'ACTIVE'.<br />It is recommended to use the <a class="confluence-link" href="/pages/viewpage.action?pageId=229743276" data-linked-resource-id="229743276" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/profiles" data-base-url="http://docs.codehaus.org">/api/profiles web service</a> instead. </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>priorities</strong></p></td><td class="confluenceTd"><p>List of INACTIVE, ACTIVE, BLOCKER, CRITICAL, MAJOR, MINOR, INFO.<br />It is recommended to use the <a class="confluence-link" href="/pages/viewpage.action?pageId=229743276" data-linked-resource-id="229743276" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/profiles" data-base-url="http://docs.codehaus.org">/api/profiles web service</a> instead of ACTIVE and INACTIVE.</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 | csv</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>