CeActivityFunc testing Search for tasks.<br> Requires the system administration permission, or project administration permission if componentId is set.

CeComponentFunc testing Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).<br>Requires the following permission: 'Browse' on the specified component.<br>Either 'componentId' or 'component' must be provided.

CeTaskFunc testing Give Compute Engine task details such as type, status, duration and associated component.<br />Requires 'Administer System' or 'Execute Analysis' permission.<br/>Since 6.1, field "logs" is deprecated and its value is always false.

ComponentsSearchFunc testing Search for components.

ComponentsShowFunc testing Returns a component (file, directory, project, view…) and its ancestors.

ComponentsTreeFunc testing Navigate through components based on the chosen strategy.

DuplicationsShowFunc testing Get duplications.

FavoritesAddFunc testing Add a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication and the following permission: 'Browse' on the project of the specified component.

FavoritesRemoveFunc testing Remove a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication.

FavoritesSearchFunc testing Search for the authenticated user favorites.<br>Requires authentication.

IssuesAddCommentFunc testing Add a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.

IssuesAssignFunc testing Assign/Unassign an issue.

IssuesAuthorsFunc testing Search SCM accounts which match a given query.

IssuesBulkChangeFunc testing Bulk change on issues.<br/>Requires authentication.

IssuesChangelogFunc testing Display changelog of an issue.<br/>Requires the 'Browse' permission on the project of the specified issue.

IssuesDeleteCommentFunc testing Delete a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.

IssuesDoTransitionFunc testing Do workflow transition on an issue.

IssuesEditCommentFunc testing Edit a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.

IssuesSearchFunc testing Search for issues.<br>At most one of the following parameters can be provided at the same time: componentKeys, componentUuids, components, componentRootUuids, componentRoots.<br>Requires the 'Browse' permission on the specified project(s).

IssuesSetSeverityFunc testing Change severity.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul>.

IssuesSetTagsFunc testing Set tags on an issue.

IssuesSetTypeFunc testing Change type of issue, for instance from 'code smell' to 'bug'.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul>.

IssuesTagsFunc testing List tags matching a given query.

LanguagesListFunc testing List supported programming languages.

MeasuresComponentFunc testing Return component with specified measures.

MeasuresComponentTreeFunc testing Navigate through components based on the chosen strategy with specified measures.

MeasuresSearchHistoryFunc testing Search measures history of a component.<br>Measures are ordered chronologically.<br>Pagination applies to the number of measures for each metric.<br>Requires the following permission: 'Browse' on the specified component.

MetricsCreateFunc testing Create custom metric.<br /> Requires 'Administer System' permission.

MetricsDeleteFunc testing Delete metrics and associated measures.

MetricsDomainsFunc testing List all custom metric domains.

MetricsSearchFunc testing Search for metrics.

MetricsTypesFunc testing List all available metric types.

MetricsUpdateFunc testing Update a custom metric.<br /> Requires 'Administer System' permission.

NotificationsAddFunc testing Add a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided.

NotificationsListFunc testing List notifications of the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul>.

NotificationsRemoveFunc testing Remove a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul>.

PermissionsAddGroupFunc testing Add permission to a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group name or group id must be provided.

PermissionsAddGroupToTemplateFunc testing Add a group to a permission template.<br /> The group id or group name must be provided.

PermissionsAddProjectCreatorToTemplateFunc testing Add a project creator to a permission template.<br>Requires the following permission: 'Administer System'.

PermissionsAddUserFunc testing Add permission to a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>.

PermissionsAddUserToTemplateFunc testing Add a user to a permission template.<br /> Requires the following permission: 'Administer System'.

PermissionsApplyTemplateFunc testing Apply a permission template to one project.<br>The project id or project key must be provided.<br>The template id or name must be provided.<br>Requires the following permission: 'Administer System'.

PermissionsBulkApplyTemplateFunc testing Apply a permission template to several projects.<br />The template id or name must be provided.<br />Requires the following permission: 'Administer System'.

PermissionsCreateTemplateFunc testing Create a permission template.<br />Requires the following permission: 'Administer System'.

PermissionsDeleteTemplateFunc testing Delete a permission template.<br />Requires the following permission: 'Administer System'.

PermissionsRemoveGroupFromTemplateFunc testing Remove a group from a permission template.<br /> The group id or group name must be provided.

PermissionsRemoveGroupFunc testing Remove a permission from a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group id or group name must be provided, not both.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>.

PermissionsRemoveProjectCreatorFromTemplateFunc testing Remove a project creator from a permission template.<br>Requires the following permission: 'Administer System'.

PermissionsRemoveUserFromTemplateFunc testing Remove a user from a permission template.<br /> Requires the following permission: 'Administer System'.

PermissionsRemoveUserFunc testing Remove permission from a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>.

PermissionsSearchTemplatesFunc testing List permission templates.<br />Requires the following permission: 'Administer System'.

PermissionsSetDefaultTemplateFunc testing Set a permission template as default.<br />Requires the following permission: 'Administer System'.

PermissionsUpdateTemplateFunc testing Update a permission template.<br />Requires the following permission: 'Administer System'.

PluginsAvailableFunc testing Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name.<br/>Plugin information is retrieved from Update Center.

PluginsCancelAllFunc testing Cancels any operation pending on any plugin (install, update or uninstall)<br/>Requires user to be authenticated with Administer System permissions.

PluginsInstalledFunc testing Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.

PluginsInstallFunc testing Installs the latest version of a plugin specified by its key.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions.

PluginsPendingFunc testing Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name.<br/>Require 'Administer System' permission.

PluginsUninstallFunc testing Uninstalls the plugin specified by its key.<br/>Requires user to be authenticated with Administer System permissions.

PluginsUpdateFunc testing Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions.

PluginsUpdatesFunc testing Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name.<br/>Each newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status.<br/>Plugin information is retrieved from Update Center.

ProjectAnalysesCreateEventFunc testing Create a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be created.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>.

ProjectAnalysesDeleteEventFunc testing Delete a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be deleted.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>.

ProjectAnalysesDeleteFunc testing Delete a project analysis.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the project of the specified analysis</li></ul>.

ProjectAnalysesSearchFunc testing Search a project analyses and attached events.<br>Requires the following permission: 'Browse' on the specified project.

ProjectAnalysesUpdateEventFunc testing Update a project analysis event.<br>Only events of category 'VERSION' and 'OTHER' can be updated.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>.

ProjectBadgesMeasureFunc testing Generate badge for project's measure as an SVG.<br/>Requires 'Browse' permission on the specified project.

ProjectBadgesQualityGateFunc testing Generate badge for project's quality gate as an SVG.<br/>Requires 'Browse' permission on the specified project.

ProjectBranchesDeleteFunc testing Delete a non-main branch of a project.<br/>Requires 'Administer' rights on the specified project.

ProjectBranchesListFunc testing List the branches of a project.<br/>Requires 'Browse' or 'Execute analysis' rights on the specified project.

ProjectBranchesRenameFunc testing Rename the main branch of a project.<br/>Requires 'Administer' permission on the specified project.

ProjectLinksCreateFunc testing Create a new project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.

ProjectLinksDeleteFunc testing Delete existing project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.

ProjectLinksSearchFunc testing List links of a project.<br>The 'projectId' or 'projectKey' must be provided.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>.

ProjectPullRequestsDeleteFunc testing Delete a pull request.<br/>Requires 'Administer' rights on the specified project.

ProjectPullRequestsListFunc testing List the pull requests of a project.<br/>One of the following permissions is required: <ul><li>'Browse' rights on the specified project</li><li>'Execute Analysis' rights on the specified project</li></ul>.

ProjectsBulkDeleteFunc testing Delete one or several projects.<br />Requires 'Administer System' permission.

ProjectsBulkUpdateKeyFunc testing Bulk update a project or module key and all its sub-components keys.

ProjectsCreateFunc testing Create a project.<br/>Requires 'Create Projects' permission.

ProjectsDeleteFunc testing Delete a project.<br> Requires 'Administer System' permission or 'Administer' permission on the project.

ProjectsSearchFunc testing Search for projects or views to administrate them.<br>Requires 'System Administrator' permission.

ProjectsUpdateKeyFunc testing Update a project or module key and all its sub-components keys.<br>Either 'from' or 'projectId' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>.

ProjectsUpdateVisibilityFunc testing Updates visibility of a project.<br>Requires 'Project administer' permission on the specified project.

ProjectTagsSearchFunc testing Search tags.

ProjectTagsSetFunc testing Set tags on a project.<br>Requires the following permission: 'Administer' rights on the specified project.

QualitygatesCopyFunc testing Copy a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesCreateConditionFunc testing Add a new condition to a quality gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesCreateFunc testing Create a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesDeleteConditionFunc testing Delete a condition from a quality gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesDeselectFunc testing Remove the association of a project from a quality gate.<br>Requires one of the following permissions:<ul><li>'Administer Quality Gates'</li><li>'Administer' rights on the project</li></ul>.

QualitygatesDestroyFunc testing Delete a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesGetByProjectFunc testing Get the quality gate of a project.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>.

QualitygatesListFunc testing Get a list of quality gates.

QualitygatesProjectStatusFunc testing Get the quality gate status of a project or a Compute Engine task.<br />Either 'analysisId', 'projectId' or 'projectKey' must be provided<br />The different statuses returned are: OK, WARN, ERROR, NONE.

QualitygatesRenameFunc testing Rename a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesSearchFunc testing Search for projects associated (or not) to a quality gate.<br/>Only authorized projects for current user will be returned.

QualitygatesSelectFunc testing Associate a project to a quality gate.<br>The 'projectId' or 'projectKey' must be provided.<br>Project id as a numeric value is deprecated since 6.1.

QualitygatesSetAsDefaultFunc testing Set a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission.

QualitygatesShowFunc testing Display the details of a quality gate.

QualitygatesUpdateConditionFunc testing Update a condition attached to a quality gate.<br>Requires the 'Administer Quality Gates' permission.

QualityProfilesActivateRuleFunc testing Activate a rule on a Quality Profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>.

QualityProfilesActivateRulesFunc testing Bulk-activate rules on one quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>.

QualityProfilesAddProjectFunc testing Associate a project with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul>.

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

QualityProfilesChangeParentFunc testing Change a quality profile's parent.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>.

QualityProfilesCopyFunc testing Copy a quality profile.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.

QualityProfilesCreateFunc testing Create a quality profile.<br>Requires to be logged in and the 'Administer Quality Profiles' permission.

QualityProfilesDeactivateRuleFunc testing Deactivate a rule on a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>.

QualityProfilesDeactivateRulesFunc testing Bulk deactivate rules on Quality profiles.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>.

QualityProfilesDeleteFunc testing Delete a quality profile and all its descendants.

QualityProfilesExportersFunc testing Lists available profile export formats.

QualityProfilesExportFunc testing Export a quality profile.

QualityProfilesImportersFunc testing List supported importers.

QualityProfilesInheritanceFunc testing Show a quality profile's ancestors and children.

QualityProfilesProjectsFunc testing List projects with their association status regarding a quality profile.

QualityProfilesRemoveProjectFunc testing Remove a project's association with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul>.

QualityProfilesRenameFunc testing Rename a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>.

QualityProfilesRestoreFunc testing Restore a quality profile using an XML file.

QualityProfilesSearchFunc testing Search quality profiles.

QualityProfilesSetDefaultFunc testing Select the default profile for a given language.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.

RulesCreateFunc testing Create a custom rule.<br>Requires the 'Administer Quality Profiles' permission.

RulesDeleteFunc testing Delete custom rule.<br/>Requires the 'Administer Quality Profiles' permission.

RulesRepositoriesFunc testing List available rule repositories.

RulesSearchFunc testing Search for a collection of relevant rules matching a specified query.<br/>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>.

RulesShowFunc testing Get detailed information about a rule<br>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>In 7.1, the field 'scope' has been added.

RulesTagsFunc testing List rule tags.

RulesUpdateFunc testing Update an existing rule.<br>Requires the 'Administer Quality Profiles' permission.

ServerVersionFunc testing Version of SonarQube in plain text.

SettingsListDefinitionsFunc testing List settings definitions.<br>Requires 'Browse' permission when a component is specified<br/>.

SettingsResetFunc testing Remove a setting value.<br>The settings defined in config/sonar.properties are read-only and can't be changed.<br/>Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul>.

SettingsSetFunc testing Update a setting value.<br>Either 'value' or 'values' must be provided.<br> The settings defined in config/sonar.properties are read-only and can't be changed.<br/>Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul>.

SettingsValuesFunc testing List settings values.<br>If no value has been set for a setting, then the default value is returned.<br>The settings from conf/sonar.properties are excluded from results.<br>Requires 'Browse' or 'Execute Analysis' permission when a component is specified<br/>.

SourcesRawFunc testing Get source code as raw text.

SourcesScmFunc testing Get SCM information of source files.

SourcesShowFunc testing Get source code.

SystemChangeLogLevelFunc testing Temporarily changes level of logs.

SystemDbMigrationStatusFunc testing Display the database migration status of SonarQube.<br/>State values are:<ul><li>NO_MIGRATION: DB is up to date with current version of SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED: DB migration has run and has been successful.</li><li>MIGRATION_FAILED: DB migration has run and failed.

SystemHealthFunc testing Provide health status of SonarQube.<p>Require 'Administer System' permission or authentication with passcode</p><p> <ul> <li>GREEN: SonarQube is fully operational</li> <li>YELLOW: SonarQube is usable, but it needs attention in order to be fully operational</li> <li>RED: SonarQube is not operational</li> </ul></p>.

SystemLogsFunc testing Get system logs in plain-text format.

SystemMigrateDbFunc testing Migrate the database to match the current version of SonarQube.<br/>Sending a POST request to this URL starts the DB migration.

SystemPingFunc testing Answers "pong" as plain-text.

SystemRestartFunc testing Restart server.

SystemStatusFunc testing Get state information about SonarQube.<p>status: the running status <ul> <li>STARTING: SonarQube Web Server is up and serving some Web Services (eg.

SystemUpgradesFunc testing Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade.<br/>Plugin information is retrieved from Update Center.

UserGroupsAddUserFunc testing Add a user to a group.<br />'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'.

UserGroupsCreateFunc testing Create a group.<br>Requires the following permission: 'Administer System'.

UserGroupsDeleteFunc testing Delete a group.

UserGroupsRemoveUserFunc testing Remove a user from a group.<br />'id' or 'name' must be provided.<br>Requires the following permission: 'Administer System'.

UserGroupsSearchFunc testing Search for user groups.<br>Requires the following permission: 'Administer System'.

UserGroupsUpdateFunc testing Update a group.<br>Requires the following permission: 'Administer System'.

UserGroupsUsersFunc testing Search for users with membership information with respect to a group.<br>Requires the following permission: 'Administer System'.

UsersChangePasswordFunc testing Update a user's password.

UsersCreateFunc testing Create a user.<br/>If a deactivated user account exists with the given login, it will be reactivated.<br/>Requires Administer System permission.

UsersDeactivateFunc testing Deactivate a user.

UsersGroupsFunc testing Lists the groups a user belongs to.

UsersSearchFunc testing Get a list of active users.

UsersUpdateFunc testing Update a user.

UserTokensGenerateFunc testing Generate a user access token.

UserTokensRevokeFunc testing Revoke a user access token.

UserTokensSearchFunc testing List the access tokens of a user.<br>The login must exist and active.<br>If the login is set, it requires administration permissions.

WebhooksCreateFunc testing Create a Webhook.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.

WebhooksDeleteFunc testing Delete a Webhook.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.

WebhooksDeliveriesFunc testing Get the recent deliveries for a specified project or Compute Engine task.<br/>Require 'Administer' permission on the related project.<br/>Note that additional information are returned by api/webhooks/delivery.

WebhooksDeliveryFunc testing Get a webhook delivery by its id.<br/>Require 'Administer System' permission.<br/>Note that additional information are returned by api/webhooks/delivery.

WebhooksListFunc testing Search for global webhooks or project webhooks.

WebhooksUpdateFunc testing Update a Webhook.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.