SonarQube Cloud

Logout a user.

Check credentials. Returns true for anonymous user.

Returns CE activity related metrics.Requires ‘Administer’ permission on the specified project.

Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project). Requires `…

Search for top-level components (projects) in the organization, filterable by name pattern and qualifier. Use this to fi…

Returns a component (file, directory, project) and its ancestors. The ancestors are ordered from the parent to the root…

Navigate through components based on the chosen strategy.Requires the following permission: ‘Browse’ on the specified pr…

Get duplications. Require Browse permission on file’s project

Add a project as favorite for the authenticated user.Only 100 components can be added as favorite.Requires authenticatio…

Remove a component (project, directory, file etc.) as favorite for the authenticated user.Requires authentication.

Search for the authenticated user favorites.Requires authentication.

Search for Security Hotspots.

Search SCM accounts which match a given query.Requires authentication.

Search for issues.Requires the ‘Browse’ permission on the specified project(s).

List tags matching a given query

List supported programming languages

Return component with specified measures. The componentId or the component parameter must be provided.Requires the follo…

Recursively walk a project’s directory/file tree and return the specified measures (e.g. coverage, complexity, ncloc) fo…

Search measures history of a component.Measures are ordered chronologically.Pagination applies to the number of measures…

Search for metrics

List all available metric types.

Add a notification for the authenticated user.Requires one of the following permissions: Authentication if no login is p…

List notifications of the authenticated user

Remove a notification for the authenticated user

Add a project creator to a permission template.Requires the permission ‘Administer’ on the organization.

Add permission to a user. This service defaults to global permissions, but can be limited to project permissions by prov…

Add a user to a permission template. Requires the permission ‘Administer’ on the organization.

Apply a permission template to one project.The project id or project key must be provided.The template id or name must b…

Apply a permission template to many projects in one call — use this to roll out (or re-roll-out) a template across a…

Create a new permission template — a reusable named bundle of permissions that can be applied to projects (via `permissi…

Delete a permission template.Requires the permission ‘Administer’ on the organization.

Remove a project creator from a permission template.Requires the permission ‘Administer’ on the organization.

Remove permission from a user. This service defaults to global permissions, but can be limited to project permissions by…

Remove a user from a permission template. Requires the permission ‘Administer’ on the organization.

List the permission templates configured for the organization (each template is a reusable named bundle of permissions t…

Set a permission template as default.Requires the permission ‘Administer’ on the organization.

Update a permission template.Requires the permission ‘Administer’ on the organization.

Pin a version tag or release marker (an “event”) onto a specific Sonar analysis. Use this to attach things like v1.2.3…

Delete a project analysis.Requires the permission ‘Administer’ on the project of the specified analysis.

Remove a version tag / release marker (an “event”) that was previously pinned to a Sonar analysis. Use this to clear a v…

Search a project analyses and attached events.Requires the following permission: ‘Browse’ on the specified project

Unset any manually-set New Code Period baseline on a project or a long-lived branch.Unsetting a manual baseline restores…

Rename an existing version tag / release marker (an “event”) on a Sonar analysis — e.g. change v1.2.3 to v1.2.4. Req…

Generate a badge for project’s AI assurance as an SVG.Requires ‘Browse’ permission on the specified project.

Generate badge for project’s measure as an SVG.Requires a security token for private projects.

Generate badge for project’s quality gate as an SVG.Requires a security token for private projects.

Delete a non-main branch of a project.Requires ‘Administer’ rights on the specified project.

List the branches of a project.The statistics are the overall counts on long branches, and the count of issues detected…

Rename the main branch of a project.Requires ‘Administer’ permission on the specified project.

Create a new project link.Requires ‘Administer’ permission on the specified project, or global ‘Administer’ permission.

Delete existing project link.Requires ‘Administer’ permission on the specified project, or global ‘Administer’ permissio…

List links of a project. Exactly one of projectId or projectKey must be provided. Requires Administer or Browse…

Delete a pull request.Requires ‘Administer’ rights on the specified project.

List the pull requests of a project.One of the following permissions is required: ‘Browse’ rights on the specified proje…

Search tags

Set tags on a project.Requires the following permission: ‘Administer’ rights on the specified project

Delete one or several projects.Only the 1’000 first items in project filters are taken into account.Requires ‘Administer…

Create a project.Requires ‘Create Projects’ permission

Delete a project. Requires ‘Administer System’ permission or ‘Administer’ permission on the project.

Search for projects. Results are filtered to projects the caller has access to.

Update a project or module key and all its sub-components keys.Requires the permission ‘Administer’ on the specified pro…

Updates visibility of a project.Requires ‘Project administer’ permission on the specified project

Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.

Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are…

Copy a quality profile. Requires to be logged in and the ‘Administer Quality Profiles’ permission.

Create a quality profile.Requires to be logged in and the ‘Administer Quality Profiles’ permission.

Delete a quality profile and all its descendants. The default quality profile cannot be deleted. Requires one of the fol…

Show a quality profile’s ancestors and children. Provide either key alone, or the trio language + qualityProfile +…

List projects with their association status regarding a quality profile

Search quality profiles

List available rule repositories

Search for a collection of relevant rules matching a specified query.Since 5.5, following fields in the response have be…

Get detailed information about a ruleSince 5.5, following fields in the response have been deprecated :“effortToFixDescr…

List rule tags

Update an existing rule.Requires the ‘Administer Quality Profiles’ permission

List settings definitions.Requires ‘Browse’ permission when a component is specifiedTo access licensed settings, authent…

Remove a setting value.The settings defined in conf/sonar.properties are read-only and can’t be changed.Requires the per…

Add a user to a group. SonarCloud identifies the group by name + organization only; numeric group id is not accept…

Create a group.Requires the following permission: ‘Administer System’.

Delete a group. The default groups cannot be deleted. SonarCloud identifies the group by name + organization only; n…

Search for user groups.Requires the following permission: ‘Administer System’.

Update a group.Requires the following permission: ‘Administer System’.

Given a group name, list the users in that group (with selection/membership flags). Use this when the question is “who i…

Generate a user access token. Please keep your tokens secret. They enable you to authenticate and analyze projects. The…

Revoke an access token of the authenticated user.

List the access tokens of the authenticated user. Field ‘lastConnectionDate’ is only updated every hour, so it may not b…

Given a user login, list every group that user is a member of. Use this when the question is “which groups does user X b…

List web services

Display web service response example