Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current ·  View Page History
<< Previous Version 6 Next >>
Table of Contents

This page lists all the available Web Services to be used by any HTTP clients.

Available Web Services

Web Service

Description

Related Pages
authentication  

events

  • get a list of events
  • create an event
Events
favourites
  • get a list of favourites
  • create a favourite
  • delete a favourite
Favourites, Filters
Installed Plugins
  • get the list of all the plugins installed on the Sonar instance
Update Center
Manual Measures
  • get a list of manual measures
  • create a manual measure
  • delete a manual measure
Manual Measures
metrics
  • get a list of metrics
  • create a metric
  • update a metric
  • delete a metric
Metrics

Project

  • delete a project
 
profiles
  • get data from quality profiles
  • backup a quality profile
  • restore a quality profile
Quality Profiles
properties
  • get a list of properties
  • create a property
  • update a property
  • delete a property
 
Resources

This Web Service deals with Resources (projects, files, views, etc.). It mainly offers to get measures from resources.

 
Reviews

This Web Service deals with Reviews. It offers to:

  • get data from reviews
  • create review
  • update review (add comment, reassign it, etc.)
 
RulesThis Web Service offers to get data from Rules. 
Server StatusThis Web Service returns the status of the Sonar server. 
SourcesThis Web Service offers to get data from Sources. 
System InfoThis Web Service returns system properties, server info (Java, OS), database configuration, JVM statistics and installed plugins. 
Time MachineThis Web Services offers to get data from Time Machine. 
User Properties

This Web Service deals with User Properties. It offers to:

  • get data from user properties
  • create user property
  • update user property
  • delete user property
 
Upgrade ServerThis Web Service returns the status of the upgrade of the server. 
ViolationsThis Web Service offers to get data from Violations. 

Response Formats

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

The request can specify the desired response format using one of the following two ways:

  • Accept HTTP header: application/json, text/xml

  • Query argument 'format' with one of these values: xml, json, txt or csv

HTTP Status Codes

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.

Labels
  • None