Web Service /api/violations

Description	Get a list of violations
URL	/api/violations
HTTP Method	GET
Response Formats	json \| xml
Security	Requires User role on project

Use Case	Example Request
Get all the violations from project Sonar (key = org.codehaus.sonar:sonar)	GET http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&depth=-1
Get all the blocker and critical violations from project Sonar (key = org.codehaus.sonar:sonar)	GET http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&depth=-1&priorities=BLOCKER,CRITICAL

JSON

Number of results

Note that the number of results is limited to 5,000.

Parameter	Description	Required	Default Value	Example Value
resource	id or key of the resource.	Yes	None	org.codehaus.sonar:sonar
depth	Used only when resource is set. 0: only selected resource -1: all children, including selected resource >0: depth toward the selected resource	No	0	-1
scopes	Comma-separated list of scopes: PRJ: project/module DIR: directory (like Java package) FIL: file	No	None	PRJ,FIL
qualifiers	Comma-separated list of qualifiers: VW: view SVW: sub-view TRK: project BRC: module CLA: class UTS: unit test DIR: directory FIL: file DEV: developer	No	None	TRK,BRC
rules	Comma-separated list of rule keys or ids.	No	None	squid:MethodCyclomatiComplexity,pmd:ConstructorCallsOverridableMethod
priorities	Comma-separated list of priorities. Possible values: BLOCKER \| CRITICAL \| MAJOR \| MINOR \| INFO	No	None	BLOCKER,CRITICAL
limit	Maximum number of results	No	5000	10
include_review	Include review data into response. Possible values: true \| false	No	false	true
output	Output format of review comments. Ignored if include_review is false. Possible values: PLAIN \| HTML	No	PLAIN	HTML
switched_off	If true, then return only switched-off violations (usually false-positives), else switched-off violations are excluded. Possible values: true \| false	No	false	true
format	Response format. Possible values: xml \| json	No	None	json