Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Available Web Services

To get the list of all the available web services and their parameters: /api/webservices/list (available since SonarQube 4.2).

 Notes:

  • This list is limited to web services written in Java. Web services written in Ruby are not listed.
  • Only web services marked as "internal: false" should be used.

Code Block
title/api/webservices/list
languagejs
{
    "webServices":[
        {
            "path":"api/issue_filters",
            "since":"4.2",
            "description":"Issue Filters",
            "actions":[
                {
                    "key":"page",
                    "description":"Data required for rendering page 'Issues'. Internal use only.",
                    "since":"4.2",
                    "internal":true,
                    "post":false
                },
                {
                    "key":"show",
                    "description":"Get detail of issue filter",
                    "since":"4.2",
                    "internal":false,
                    "post":false,
                    "params":[{"key":"id"}]
                }
            ]
        },
        {
            "path":"api/issues",
            ...

Issues

 

Web Service

Examples of use cases that can be fulfilled

issues

Get a list of issues
Assign/Unassign as issue
Create a manual issue

rules

Get the deails of a rule
Get a list of rules
Add tags to a rule
Remove tags from a rule 

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

qualitygates

List all the quality gates
Display details of a quality gate
Create / Rename / Copy / Delete a quality gate
Create / Update / Delete a condition 

rule_tags

Create a rule tag
Get the list of available rule tags

action_plans

Get a list of action plans
Create / Update / Delete an action plan
Close / Open an action plan

violations

Deprecated since version 3.6. Replaced by the issues web service.

reviews

Deprecated since version 3.6. Replaced by the issues web service.

issue_filters

Get the Detail of an Issue Filter

Get a list of favorite Issue filters

Project Measures

Web Service

Examples of use cases that can be fulfilled

resources (Components)

Get a list of components

resources (Measures)Get the measures of a list of metrics on a given component
manual_measures

Get a list of manual measures
Create or update a manual measure
Delete a manual measure

metrics

Get a list of metrics
Create / Update / Delete a manual metric 

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

projects

Delete a project
Provision a project 

properties

Get a list of properties
Create a property
Update a property
Delete a property

server

Get the status of the SonarQubeserverSonarQube server
Upgrade the SonarQube database
Get the system properties

system

Restart the server (dev mode only)

updatecenter/installed_plugins

Get the list of all the plugins installed on the SonarQube instance

...