Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0yfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=2"></p></td></tr></table><p>This page lists all the available Web Services to be used by any HTTP clients.</p><h1>Available Web Services</h1><h2>Issues</h2><table class="confluenceTable"><tbody><tr><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Web Service</span></th><th class="confluenceTh"><p>Examples of use cases that can be fulfilled</p></th></tr><tr><td colspan="1" class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743298" data-linked-resource-id="229743298" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/violations" data-base-url="http://docs.codehaus.org">violations</a></strong></td><td colspan="1" class="confluenceTd"><p>Get a list of violations on a given resource<br />Get all the violations of a project<br />Get the blocker and critical violations of a project</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743282" data-linked-resource-id="229743282" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/reviews" data-base-url="http://docs.codehaus.org">reviews</a></strong></td><td class="confluenceTd"><p>Get a list of reviews<br />Create a review<br />Update a review (add comment, reassign it, etc.)</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743284" data-linked-resource-id="229743284" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/rules" data-base-url="http://docs.codehaus.org">rules</a></strong></td><td class="confluenceTd"><p><span>Get a list of rules</span></p></td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,109,175);text-decoration: underline;"><a class="confluence-link" href="/pages/viewpage.action?pageId=229743276" data-linked-resource-id="229743276" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/profiles" data-base-url="http://docs.codehaus.org">profiles</a></span></strong></td><td class="confluenceTd"><p>Get a list of profiles<br />Get the list of coding rules activated in a quality profile<br />Backup a quality profile<br />Restore a quality profile<br />Delete a profile<br />Set a profile as default</p></td></tr></tbody></table><h2>Project Measures</h2><table class="confluenceTable"><tbody><tr><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Web Service</span></th><th class="confluenceTh"><p>Examples of use cases that can be fulfilled</p></th></tr><tr><td colspan="1" class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743280" data-linked-resource-id="229743280" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/resources" data-base-url="http://docs.codehaus.org">resources</a> (Resource)</strong></td><td colspan="1" class="confluenceTd"><p>Get a list of resources </p></td></tr><tr><td colspan="1" class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743280" data-linked-resource-id="229743280" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/resources" data-base-url="http://docs.codehaus.org">resources</a> (Measures)</strong></td><td colspan="1" class="confluenceTd"><span>Get the measures of a list of metrics on a given resource</span></td></tr><tr><td colspan="1" class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743270" data-linked-resource-id="229743270" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/manual_measures" data-base-url="http://docs.codehaus.org">manual_measures</a></strong></td><td colspan="1" class="confluenceTd"><p>Get a list of manual measures<br />Create or update a manual measure<br />Delete a manual measure</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743272" data-linked-resource-id="229743272" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/metrics" data-base-url="http://docs.codehaus.org">metrics</a></strong></td><td class="confluenceTd"><p>Get a list of metrics</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743292" data-linked-resource-id="229743292" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/timemachine" data-base-url="http://docs.codehaus.org">timemachine</a></strong></td><td class="confluenceTd"><p>Get past measures</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743288" data-linked-resource-id="229743288" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/sources" data-base-url="http://docs.codehaus.org">sources</a></strong></td><td class="confluenceTd"><p>Get a list of lines from source files</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743167" data-linked-resource-id="229743167" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/events" data-base-url="http://docs.codehaus.org">events</a></strong></td><td class="confluenceTd"><p>Get a list of events from a project</p></td></tr></tbody></table><h2>User</h2><table class="confluenceTable"><tbody><tr><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Web Service</span></th><th class="confluenceTh"><p>Examples of use cases that can be fulfilled</p></th></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743294" data-linked-resource-id="229743294" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/user_properties" data-base-url="http://docs.codehaus.org">user_properties</a></strong></td><td class="confluenceTd"><p>Get a list of user properties<br />Create a user property<br />Update a user property<br />Delete a user property</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743266" data-linked-resource-id="229743266" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/favourites" data-base-url="http://docs.codehaus.org">favourites</a></strong></td><td colspan="1" class="confluenceTd"><p>Get the logged in user's list of favourites<br />Create a favourite<br />Delete a favourite</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743649" data-linked-resource-id="229743649" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/authentication" data-base-url="http://docs.codehaus.org">authentication</a></strong></td><td class="confluenceTd"><p>Check authentication</p></td></tr></tbody></table><h2>Administration</h2><table class="confluenceTable"><tbody><tr><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Web Service</span></th><th class="confluenceTh"><p>Examples of use cases that can be fulfilled</p></th></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743274" data-linked-resource-id="229743274" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/projects" data-base-url="http://docs.codehaus.org">projects</a></strong></td><td class="confluenceTd"><p>Delete a project</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743278" data-linked-resource-id="229743278" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/properties" data-base-url="http://docs.codehaus.org">properties</a></strong></td><td class="confluenceTd"><p>Get a list of properties<br />Create a property<br />Update a property<br />Delete a property</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743286" data-linked-resource-id="229743286" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/server" data-base-url="http://docs.codehaus.org">server</a></strong></td><td class="confluenceTd"><p>Get the status of the Sonar server<br />Upgrade the Sonar database<br />Get the system properties</p></td></tr><tr><td class="confluenceTd"><strong><a class="confluence-link" href="/pages/viewpage.action?pageId=229743268" data-linked-resource-id="229743268" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/updatecenter/installed_plugins" data-base-url="http://docs.codehaus.org">updatecenter/installed_plugins</a></strong></td><td class="confluenceTd"><p>Get the list of all the plugins installed on the Sonar instance</p></td></tr></tbody></table><h1>Response Formats</h1><p>The API provides several response formats such as XML, <a href="http://www.json.org/">JSON</a> (ie. JavaScript Object Notation) plain text or CSV.</p><p>Check the available formats on the page of each web service.</p><h1>HTTP Status Codes</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>HTTP Code</p></th><th class="confluenceTh"><p>Description</p></th></tr><tr><td class="confluenceTd"><p>200</p></td><td class="confluenceTd"><p>OK</p></td></tr><tr><td class="confluenceTd"><p>400</p></td><td class="confluenceTd"><p>Bad request. <br class="atl-forced-newline" />The request could not be understood by the server due to malformed syntax.</p></td></tr><tr><td class="confluenceTd"><p>401</p></td><td class="confluenceTd"><p>Unauthorized</p></td></tr><tr><td class="confluenceTd"><p>403</p></td><td class="confluenceTd"><p>Forbidden. <br class="atl-forced-newline" />The request was a legal request, but the server is refusing to respond to it.</p></td></tr><tr><td class="confluenceTd"><p>404</p></td><td class="confluenceTd"><p>The requested resource could not be found.</p></td></tr><tr><td class="confluenceTd"><p>500</p></td><td class="confluenceTd"><p>Internal server error.</p></td></tr></tbody></table><h1>Authentication</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Use Case</p></th><th class="confluenceTh"><p>Example Request</p></th></tr><tr><td class="confluenceTd"><p>Basic HTTP authentication.<br />Example with curl to get the <a class="confluence-link" href="/pages/viewpage.action?pageId=229743286" data-linked-resource-id="229743286" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/server" data-base-url="http://docs.codehaus.org">server system properties</a> with the user admin/admin. </p></td><td class="confluenceTd"><blockquote><p>curl -u admin:admin http://localhost:9000/api/server/system</p></blockquote></td></tr></tbody></table>