Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
DescriptionGet a list of rules

URL

/api/rules

HTTP MethodGET
Response Formatsjson | xml | csv

Security

None

Examples

Use CaseExample Request
Get all the java rules

GET http://nemo.sonarsource.org/api/rules?language=java

Get all the java rules from pmd and findbugs

GET http://nemo.sonarsource.org/api/rules?language=java&plugin=pmd,findbugs

Response Format

Code Block
titleJSON
languagejavascript
[
  {
    "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:"
      }
    ]
  },
  ...
]

Parameters

Parameter

Description

Required

Default Value

Example Value

language

Key of the language

No

Nonejava

plugin

Comma-separated list of rules plugins

No

None

findbugs,pmd

searchtext

To filter on rules containing a specified text in their name, key or title

No

None

braces

profile

When this parameter is defined, a node 'status' is added for each 'rule' node with values 'INACTIVE' or 'ACTIVE'.
It is recommended to use the /api/profiles web service instead. 

No

None

Sonar%20way

priorities

List of INACTIVE, ACTIVE, BLOCKER, CRITICAL, MAJOR, MINOR, INFO.
It is recommended to use the /api/profiles web service instead of ACTIVE and INACTIVE.

No

None

BLOCKER,CRITICAL

format

Response format can be set through:

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