Available Web Services

Issues

Web Service	Examples of use cases that can be fulfilled
violations	Get a list of violations on a given resource Get all the violations of a project Get the blocker and critical violations of a project
reviews	Get a list of reviews Create a review Update a review (add comment, reassign it, etc.)
rules	Get a list of rules
profiles	Get a list of profiles Get the list of coding rules activated in a quality profile Backup a quality profile Restore a quality profile Delete a profile Set a profile as default

Web Service	Examples of use cases that can be fulfilled
resources (Resource)	Search resources by name
resources (Measures)	Get the measures of a list of metrics on a given resource
manual_measures	Get a list of manual measures Create or update a manual measure Delete a manual measure
metrics	Get a list of metrics
timemachine	Get past measures
sources	Get a list of lines from source files
events	Get a list of events from a project

Web Service	Examples of use cases that can be fulfilled
user_properties	Get a list of user properties Create a user property Update a user property Delete a user property
favourites	Get the logged in user's list of favourites Create a favourite Delete a favourite
authentication	Check authentication

Web Service	Examples of use cases that can be fulfilled
projects	Delete a project
properties	Get a list of properties Create a property Update a property Delete a property
server	Get the status of the Sonar server Upgrade the Sonar database Get the system properties
updatecenter/installed_plugins	Get the list of all the plugins installed on the Sonar instance

The API provides several response formats such as XML, JSON (ie. JavaScript Object Notation) plain text or CSV.

Check the available formats on the page of each web service.

HTTP Code	Description
200	OK
400	Bad request. The request could not be understood by the server due to malformed syntax.
401	Unauthorized
403	Forbidden. The request was a legal request, but the server is refusing to respond to it.
404	The requested resource could not be found.
500	Internal server error.

Use Case	Example Request
Basic HTTP authentication. Example with curl to get the server system properties with the user admin/admin.	curl -u admin:admin http://localhost:9000/api/server/system