| Table of Contents Error rendering macro 'toc' : The minLevel (3) is greater than the maxLevel (2) |
This page lists all the available Web Services to be used by any HTTP clients.
Available Web Services
Violations and Reviews
| Domain | Examples of use cases that can be fulfilled | Web Service |
|---|---|---|
| Violations |
| /api/violations |
| Reviews |
| /api/reviews |
Resources and Measures
| Domain | Examples of use cases that can be fulfilled | Web Service |
|---|---|---|
| Measures, Resources |
| /api/resources |
| Manual Measures |
| /api/manual_measures |
| Time Machine |
| /api/timemachine |
| Sources |
| /api/sources |
Administration
| Domain | Examples of use cases that can be fulfilled | Web Service |
|---|---|---|
| Metrics |
| /api/metrics |
| Quality Profiles |
| /api/profiles |
| Rules |
| /api/rules |
| Properties |
| /api/properties |
| User Properties |
| /api/user_properties |
| Project Settings |
| /api/projects |
| Security |
| /sessions/login |
| Server |
| /api/server |
| Update Center |
| /api/updatecenter/installed_plugins |
| Events |
| /api/events |
| Favourites |
| /api/favourites |
Simple MS Excel Samples
Extracting a list of Measures of a Project: download the MS Excel sample
Extracting all the Violations of a Project: download the MS Excel sample
| Authentication In case your Sonar server is secured, you will also have to manage authentication. Here's an MS Excel sample to deal with it. |
Response Formats
The API provides several response formats such as XML, JSON (ie. JavaScript Object Notation) plain text or CSV.
Check the proper web service documentation to get the list of available format responses.
HTTP Status Codes
HTTP Code | Description |
|---|---|
200 | OK |
400 | Bad request. |
401 | Unauthorized |
403 | Forbidden. |
404 | The requested resource could not be found. |
500 | Internal server error. |

