KosmoKrator

data

SonarQube MCP, CLI, and Lua Integration for AI Agents

SonarQube integration docs for AI agents: MCP gateway setup, SonarQube CLI commands, Lua API reference, credentials, and function schemas.

SonarQube for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

SonarQube CLIHeadless setup, JSON output, direct function calls. SonarQube MCPExpose selected tools to local MCP clients. SonarQube LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug
sonarqube
route_slug
sonarqube
package
sonarqube
auth_strategy
bearer_token
cli_setup_supported
true
cli_runtime_supported
true
mcp_gateway_supported
true
lua_supported
true

Function Catalog

FunctionTypeParametersDescription
sonarqube.sonarqube_alm_integrations_import_azure_project Write write 0 Create a SonarQube project with the information from the provided Azure DevOps project. Autoconfigure pull request decoration mechanism. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_azure_pro
sonarqube.sonarqube_alm_integrations_import_bitbucketcloud_repo Write write 0 Create a SonarQube project with the information from the provided Bitbucket Cloud repository. Autoconfigure pull request decoration mechanism. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_bit
sonarqube.sonarqube_alm_integrations_import_bitbucketserver_project Write write 0 Create a SonarQube project with the information from the provided BitbucketServer project. Autoconfigure pull request decoration mechanism. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_bitbuc
sonarqube.sonarqube_alm_integrations_import_github_project Write write 0 Create a SonarQube project with the information from the provided GitHub repository. Autoconfigure pull request decoration mechanism. If Automatic Provisioning is enable for GitHub, it will also synchronize permissions from the repository. Requires the 'Create
sonarqube.sonarqube_alm_integrations_import_gitlab_project Write write 0 Import a GitLab project to SonarQube, creating a new project and configuring MR decoration Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_gitlab_project. Deprecated since SonarQube 10.5; kept
sonarqube.sonarqube_alm_integrations_list_azure_projects Read read 0 List Azure projects Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/list_azure_projects.
sonarqube.sonarqube_alm_integrations_list_bitbucketserver_projects Read read 0 List the Bitbucket Server projects Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/list_bitbucketserver_projects.
sonarqube.sonarqube_alm_integrations_search_azure_repos Read read 0 Search the Azure repositories Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_azure_repos.
sonarqube.sonarqube_alm_integrations_search_bitbucketcloud_repos Read read 0 Search the Bitbucket Cloud repositories Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_bitbucketcloud_repos.
sonarqube.sonarqube_alm_integrations_search_bitbucketserver_repos Read read 0 Search the Bitbucket Server repositories with REPO_ADMIN access Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_bitbucketserver_repos.
sonarqube.sonarqube_alm_integrations_search_gitlab_repos Read read 0 Search the GitLab projects. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_gitlab_repos.
sonarqube.sonarqube_alm_integrations_set_pat Write write 0 Set a Personal Access Token for the given DevOps Platform setting Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/set_pat.
sonarqube.sonarqube_alm_settings_count_binding Read read 0 Count number of project bound to an DevOps Platform setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: GET /api/alm_settings/count_binding.
sonarqube.sonarqube_alm_settings_create_azure Write write 0 Create Azure instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_azure.
sonarqube.sonarqube_alm_settings_create_bitbucket Write write 0 Create Bitbucket instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_bitbucket.
sonarqube.sonarqube_alm_settings_create_bitbucketcloud Write write 0 Configure a new instance of Bitbucket Cloud. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_bitbucketcloud.
sonarqube.sonarqube_alm_settings_create_github Write write 0 Create GitHub instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_github.
sonarqube.sonarqube_alm_settings_create_gitlab Write write 0 Create GitLab instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_gitlab.
sonarqube.sonarqube_alm_settings_delete Write write 0 Delete an DevOps Platform Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/delete.
sonarqube.sonarqube_alm_settings_delete_binding Write write 0 Delete the DevOps Platform binding of a project. Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settings/delete_binding.
sonarqube.sonarqube_alm_settings_get_binding Read read 0 Get DevOps Platform binding of a given project. Requires the 'Browse' permission on the project Official SonarQube Web API endpoint: GET /api/alm_settings/get_binding.
sonarqube.sonarqube_alm_settings_list Read read 0 List DevOps Platform setting available for a given project, sorted by DevOps Platform key Requires the 'Administer project' permission if the 'project' parameter is provided, requires the 'Create Projects' permission otherwise. Official SonarQube Web API endp
sonarqube.sonarqube_alm_settings_list_definitions Read read 0 List DevOps Platform Settings, sorted by created date. Requires the 'Administer System' permission Official SonarQube Web API endpoint: GET /api/alm_settings/list_definitions.
sonarqube.sonarqube_alm_settings_set_azure_binding Write write 0 Bind a Azure DevOps instance to a project. If the project was already bound to a previous Azure DevOps instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_
sonarqube.sonarqube_alm_settings_set_bitbucket_binding Write write 0 Bind a Bitbucket instance to a project. If the project was already bound to a previous Bitbucket instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settin
sonarqube.sonarqube_alm_settings_set_bitbucketcloud_binding Write write 0 Bind a Bitbucket Cloud setting to a project. If the project was already bound to a different Bitbucket Cloud setting, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api
sonarqube.sonarqube_alm_settings_set_github_binding Write write 0 Bind a GitHub instance to a project. If the project was already bound to a previous GitHub instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settings/set
sonarqube.sonarqube_alm_settings_set_gitlab_binding Write write 0 Bind a GitLab instance to a project. If the project was already bound to a previous Gitlab instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settings/set
sonarqube.sonarqube_alm_settings_update_azure Write write 0 Update Azure instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_azure.
sonarqube.sonarqube_alm_settings_update_bitbucket Write write 0 Update Bitbucket instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_bitbucket.
sonarqube.sonarqube_alm_settings_update_bitbucketcloud Write write 0 Update Bitbucket Cloud Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_bitbucketcloud.
sonarqube.sonarqube_alm_settings_update_github Write write 0 Update GitHub instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_github.
sonarqube.sonarqube_alm_settings_update_gitlab Write write 0 Update GitLab instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_gitlab.
sonarqube.sonarqube_alm_settings_validate Read read 0 Validate an DevOps Platform Setting by checking connectivity and permissions Requires the 'Administer System' permission Official SonarQube Web API endpoint: GET /api/alm_settings/validate.
sonarqube.sonarqube_analysis_cache_get Read read 0 Get the scanner's cached data for a branch. Requires scan permission on the project. Data is returned gzipped if the corresponding 'Accept-Encoding' header is set in the request. Official SonarQube Web API endpoint: GET /api/analysis_cache/get.
sonarqube.sonarqube_applications_add_project Write write 0 Add a project to an application. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/add_project.
sonarqube.sonarqube_applications_create Write write 0 Create a new application. Requires 'Administer System' permission or 'Create Applications' permission Official SonarQube Web API endpoint: POST /api/applications/create.
sonarqube.sonarqube_applications_create_branch Write write 0 Create a new branch on a given application. Requires 'Administrator' permission on the application and 'Browse' permission on its child projects Official SonarQube Web API endpoint: POST /api/applications/create_branch.
sonarqube.sonarqube_applications_delete Write write 0 Delete an application definition. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/delete.
sonarqube.sonarqube_applications_delete_branch Write write 0 Delete a branch on a given application. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/delete_branch.
sonarqube.sonarqube_applications_remove_project Write write 0 Remove a project from an application Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/remove_project.
sonarqube.sonarqube_applications_set_tags Write write 0 Set tags on a application. Requires the following permission: 'Administer' rights on the specified application Official SonarQube Web API endpoint: POST /api/applications/set_tags.
sonarqube.sonarqube_applications_show Read read 0 Returns an application and its associated projects. Requires the 'Browse' permission on the application and on its child projects. Official SonarQube Web API endpoint: GET /api/applications/show.
sonarqube.sonarqube_applications_update Write write 0 Update an application. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/update.
sonarqube.sonarqube_applications_update_branch Write write 0 Update a branch on a given application. Requires 'Administrator' permission on the application and 'Browse' permission on its child projects Official SonarQube Web API endpoint: POST /api/applications/update_branch.
sonarqube.sonarqube_audit_logs_download Read read 0 Returns security related audits of this SonarQube instance. Logs are returned in JSON format. Requires the system administration permission Official SonarQube Web API endpoint: GET /api/audit_logs/download.
sonarqube.sonarqube_authentication_login Write write 0 Authenticate a user. Official SonarQube Web API endpoint: POST /api/authentication/login.
sonarqube.sonarqube_authentication_logout Write write 0 Logout a user. Official SonarQube Web API endpoint: POST /api/authentication/logout.
sonarqube.sonarqube_authentication_validate Read read 0 Check credentials. Official SonarQube Web API endpoint: GET /api/authentication/validate.
sonarqube.sonarqube_ce_activity Read read 0 Search for tasks. Requires the system administration permission, or project administration permission if component is set. Official SonarQube Web API endpoint: GET /api/ce/activity.
sonarqube.sonarqube_ce_activity_status Read read 0 Returns CE activity related metrics. Requires 'Administer System' permission or 'Administer' rights on the specified project. Official SonarQube Web API endpoint: GET /api/ce/activity_status.
sonarqube.sonarqube_ce_component Read read 0 Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project). Requires the following permission: 'Browse' on the specified component. Official SonarQube Web API endpoint: GET /api/ce/component.
sonarqube.sonarqube_ce_task Read read 0 Give Compute Engine task details such as type, status, duration and associated component. Requires one of the following permissions: - 'Administer' at global or project level; - 'Execute Analysis' at global or project level; Since 6.1, field "logs" is deprecat
sonarqube.sonarqube_components_search Read read 0 Search for components Official SonarQube Web API endpoint: GET /api/components/search.
sonarqube.sonarqube_components_show Read read 0 Returns a component (file, directory, project, portfolio…) and its ancestors. The ancestors are ordered from the parent to the root project. Requires the following permission: 'Browse' on the project of the specified component. Official SonarQube Web API endp
sonarqube.sonarqube_components_tree Read read 0 Navigate through components based on the chosen strategy. Requires the following permission: 'Browse' on the specified project. When limiting search with the q parameter, directories are not returned. Official SonarQube Web API endpoint: GET /api/components/t
sonarqube.sonarqube_duplications_show Read read 0 Get duplications. Require Browse permission on file's project Official SonarQube Web API endpoint: GET /api/duplications/show.
sonarqube.sonarqube_editions_activate_grace_period Write write 0 Enable a license 7-days grace period if the Server ID is invalid. Require 'Administer System' permission. Official SonarQube Web API endpoint: POST /api/editions/activate_grace_period.
sonarqube.sonarqube_editions_set_license Write write 0 Set the license for enabling features of commercial editions. Require 'Administer System' permission. Official SonarQube Web API endpoint: POST /api/editions/set_license. Deprecated since SonarQube 2025.6; kept for API parity with servers that still expose i
sonarqube.sonarqube_favorites_add Write write 0 Add a component (project, portfolio, etc.) as favorite for the authenticated user. Only 100 components by qualifier can be added as favorite. Requires authentication and the following permission: 'Browse' on the component. Official SonarQube Web API endpoint:
sonarqube.sonarqube_favorites_remove Write write 0 Remove a component (project, portfolio, application etc.) as favorite for the authenticated user. Requires authentication. Official SonarQube Web API endpoint: POST /api/favorites/remove.
sonarqube.sonarqube_favorites_search Read read 0 Search for the authenticated user favorites. Requires authentication. Official SonarQube Web API endpoint: GET /api/favorites/search.
sonarqube.sonarqube_hotspots_change_status Write write 0 Change the status of a Security Hotpot. Requires the 'Administer Security Hotspot' permission. Official SonarQube Web API endpoint: POST /api/hotspots/change_status.
sonarqube.sonarqube_hotspots_search Read read 0 Search for Security Hotpots. Requires the 'Browse' permission on the specified project(s). For applications, it also requires 'Browse' permission on its child projects. When issue indexing is in progress returns 503 service unavailable HTTP code. Official Son
sonarqube.sonarqube_hotspots_show Read read 0 Provides the details of a Security Hotspot. Official SonarQube Web API endpoint: GET /api/hotspots/show.
sonarqube.sonarqube_issues_add_comment Write write 0 Add a comment. Requires authentication and the following permission: 'Browse' on the project of the specified issue. Official SonarQube Web API endpoint: POST /api/issues/add_comment.
sonarqube.sonarqube_issues_assign Write write 0 Assign/Unassign an issue. Requires authentication and Browse permission on project Official SonarQube Web API endpoint: POST /api/issues/assign.
sonarqube.sonarqube_issues_authors Read read 0 Search SCM accounts which match a given query. Requires authentication. When issue indexing is in progress returns 503 service unavailable HTTP code. Official SonarQube Web API endpoint: GET /api/issues/authors.
sonarqube.sonarqube_issues_bulk_change Write write 0 Bulk change on issues. Up to 500 issues can be updated. Requires authentication. Official SonarQube Web API endpoint: POST /api/issues/bulk_change.
sonarqube.sonarqube_issues_changelog Read read 0 Display changelog of an issue. Requires the 'Browse' permission on the project of the specified issue. Official SonarQube Web API endpoint: GET /api/issues/changelog.
sonarqube.sonarqube_issues_delete_comment Write write 0 Delete a comment. Requires authentication and the following permission: 'Browse' on the project of the specified issue. Official SonarQube Web API endpoint: POST /api/issues/delete_comment.
sonarqube.sonarqube_issues_do_transition Write write 0 Do workflow transition on an issue. Requires authentication and Browse permission on project. The transitions 'accept', 'wontfix' and 'falsepositive' require the permission 'Administer Issues'. The transitions involving security hotspots require the permission
sonarqube.sonarqube_issues_edit_comment Write write 0 Edit a comment. Requires authentication and the following permission: 'Browse' on the project of the specified issue. Official SonarQube Web API endpoint: POST /api/issues/edit_comment.
sonarqube.sonarqube_issues_gitlab_sast_export Read read 0 Return a list of vulnerabilities according to the Gitlab SAST JSON format. The JSON produced can be used in GitLab for generating the Vulnerability Report.Requires the 'Browse' or 'Scan' permission on the specified project. Official SonarQube Web API endpoint
sonarqube.sonarqube_issues_reindex Write write 0 Reindex issues for a project. Require 'Administer System' permission. Official SonarQube Web API endpoint: POST /api/issues/reindex.
sonarqube.sonarqube_issues_search Read read 0 Search for issues. Requires the 'Browse' permission on the specified project(s). For applications, it also requires 'Browse' permission on its child projects. When issue indexing is in progress returns 503 service unavailable HTTP code. Official SonarQube Web
sonarqube.sonarqube_issues_set_severity Write write 0 Change severity. Requires the following permissions: - 'Authentication'; - 'Browse' rights on project of the specified issue; - 'Administer Issues' rights on project of the specified issue; Official SonarQube Web API endpoint: POST /api/issues/set_severity.
sonarqube.sonarqube_issues_set_tags Write write 0 Set tags on an issue. Requires authentication and Browse permission on project Official SonarQube Web API endpoint: POST /api/issues/set_tags.
sonarqube.sonarqube_issues_set_type Write write 0 Change type of issue, for instance from 'code smell' to 'bug'. Requires the following permissions: - 'Authentication'; - 'Browse' rights on project of the specified issue; - 'Administer Issues' rights on project of the specified issue; Official SonarQube Web
sonarqube.sonarqube_issues_tags Read read 0 List tags matching a given query Official SonarQube Web API endpoint: GET /api/issues/tags.
sonarqube.sonarqube_languages_list Read read 0 List supported programming languages Official SonarQube Web API endpoint: GET /api/languages/list.
sonarqube.sonarqube_measures_component Read read 0 Return component with specified measures. Requires one of the following permissions:- 'Browse' on the project of the specified component; - 'Execute Analysis' on the project of the specified component; Official SonarQube Web API endpoint: GET /api/measures/co
sonarqube.sonarqube_measures_component_tree Read read 0 Navigate through components based on the chosen strategy with specified measures. Requires the following permission: 'Browse' on the specified project. For applications, it also requires 'Browse' permission on its child projects. When limiting search with the
sonarqube.sonarqube_measures_search_history Read read 0 Search measures history of a component. Measures are ordered chronologically. Pagination applies to the number of measures for each metric. Requires the following permission: 'Browse' on the specified component. For applications, it also requires 'Browse' perm
sonarqube.sonarqube_metrics_search Read read 0 Search for metrics Official SonarQube Web API endpoint: GET /api/metrics/search.
sonarqube.sonarqube_metrics_types Read read 0 List all available metric types. Official SonarQube Web API endpoint: GET /api/metrics/types.
sonarqube.sonarqube_monitoring_metrics Read read 0 Return monitoring metrics in Prometheus format. Support content type 'text/plain' (default) and 'application/openmetrics-text'. This endpoint can be accessed using a Bearer token, which needs to be defined in sonar.properties with the 'sonar.web.systemPasscode
sonarqube.sonarqube_new_code_periods_list Read read 0 Lists the new code definition for all branches in a project. Requires the permission to browse the project Official SonarQube Web API endpoint: GET /api/new_code_periods/list.
sonarqube.sonarqube_new_code_periods_set Write write 0 Updates the new code definition on different levels: - Not providing a project key and a branch key will update the default value at global level. Existing projects or branches having a specific new code definition will not be impacted; - Project key must be p
sonarqube.sonarqube_new_code_periods_show Read read 0 Shows the new code definition. If the component requested doesn't exist or if no new code definition is set for it, a value is inherited from the project or from the global setting.Requires one of the following permissions if a component is specified: - 'Admin
sonarqube.sonarqube_new_code_periods_unset Write write 0 Unsets the new code definition for a branch, project or global. It requires the inherited New Code Definition to be compatible with the Clean as You Code methodology, and one of the following permissions: - 'Administer System' to change the global setting; - '
sonarqube.sonarqube_notifications_add Write write 0 Add a notification for the authenticated user. Requires one of the following permissions: - Authentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project.; - System administration if a login is prov
sonarqube.sonarqube_notifications_list Read read 0 List notifications of the authenticated user. Requires one of the following permissions: - Authentication if no login is provided; - System administration if a login is provided; Official SonarQube Web API endpoint: GET /api/notifications/list.
sonarqube.sonarqube_notifications_remove Write write 0 Remove a notification for the authenticated user. Requires one of the following permissions: - Authentication if no login is provided; - System administration if a login is provided; Official SonarQube Web API endpoint: POST /api/notifications/remove.
sonarqube.sonarqube_permissions_add_group Write write 0 Add a permission to a group. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key. The group name must be provided. Requires one of the following permissions:- 'Administer System'; - 'Adm
sonarqube.sonarqube_permissions_add_group_to_template Write write 0 Add a group to a permission template. The group name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/add_group_to_template.
sonarqube.sonarqube_permissions_add_project_creator_to_template Write write 0 Add a project creator to a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/add_project_creator_to_template.
sonarqube.sonarqube_permissions_add_user Write write 0 Add permission to a user. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key. Requires one of the following permissions:- 'Administer System'; - 'Administer' rights on the specified pro
sonarqube.sonarqube_permissions_add_user_to_template Write write 0 Add a user to a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/add_user_to_template.
sonarqube.sonarqube_permissions_apply_template Write write 0 Apply a permission template to one project. The project id or project key must be provided. The template id or name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/apply_temp
sonarqube.sonarqube_permissions_bulk_apply_template Write write 0 Apply a permission template to several components. Managed projects will be ignored. The template id or name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/bulk_apply_templa
sonarqube.sonarqube_permissions_create_template Write write 0 Create a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/create_template.
sonarqube.sonarqube_permissions_delete_template Write write 0 Delete a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/delete_template.
sonarqube.sonarqube_permissions_remove_group Write write 0 Remove a permission from a group. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key. The group name must be provided. Requires one of the following permissions:- 'Administer System'; -
sonarqube.sonarqube_permissions_remove_group_from_template Write write 0 Remove a group from a permission template. The group name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/remove_group_from_template.
sonarqube.sonarqube_permissions_remove_project_creator_from_template Write write 0 Remove a project creator from a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/remove_project_creator_from_template.
sonarqube.sonarqube_permissions_remove_user Write write 0 Remove permission from a user. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key. Requires one of the following permissions:- 'Administer System'; - 'Administer' rights on the specifie
sonarqube.sonarqube_permissions_remove_user_from_template Write write 0 Remove a user from a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/remove_user_from_template.
sonarqube.sonarqube_permissions_search_templates Read read 0 List permission templates. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: GET /api/permissions/search_templates.
sonarqube.sonarqube_permissions_set_default_template Write write 0 Set a permission template as default. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/set_default_template.
sonarqube.sonarqube_permissions_update_template Write write 0 Update a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/update_template.
sonarqube.sonarqube_plugins_available Read read 0 Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name. Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response. Update status
sonarqube.sonarqube_plugins_cancel_all Write write 0 Cancels any operation pending on any plugin (install, update or uninstall) Requires user to be authenticated with Administer System permissions Official SonarQube Web API endpoint: POST /api/plugins/cancel_all.
sonarqube.sonarqube_plugins_install Write write 0 Installs the latest version of a plugin specified by its key. Plugin information is retrieved from Update Center. Fails if used on commercial editions or plugin risk consent has not been accepted. Requires user to be authenticated with Administer System permis
sonarqube.sonarqube_plugins_installed Read read 0 Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name. Requires authentication. Official SonarQube Web API endpoint: GET /api/plugins/installed.
sonarqube.sonarqube_plugins_pending Read read 0 Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name. Require 'Administer System' permission. Official SonarQube Web API endpoint: GET /api/plugins/pending.
sonarqube.sonarqube_plugins_uninstall Write write 0 Uninstalls the plugin specified by its key. Requires user to be authenticated with Administer System permissions. Official SonarQube Web API endpoint: POST /api/plugins/uninstall.
sonarqube.sonarqube_plugins_update Write write 0 Updates a plugin specified by its key to the latest version compatible with the SonarQube instance. Plugin information is retrieved from Update Center. Requires user to be authenticated with Administer System permissions Official SonarQube Web API endpoint: P
sonarqube.sonarqube_plugins_updates Read read 0 Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name. Each newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status. Plugin information is ret
sonarqube.sonarqube_project_analyses_create_event Write write 0 Create a project analysis event. Only event of category 'VERSION' and 'OTHER' can be created. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified project; Official SonarQube Web API endpoint: POST /api/proj
sonarqube.sonarqube_project_analyses_delete Write write 0 Delete a project analysis. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the project of the specified analysis; Official SonarQube Web API endpoint: POST /api/project_analyses/delete.
sonarqube.sonarqube_project_analyses_delete_event Write write 0 Delete a project analysis event. Only event of category 'VERSION' and 'OTHER' can be deleted. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified project; Official SonarQube Web API endpoint: POST /api/proj
sonarqube.sonarqube_project_analyses_search Read read 0 Search a project analyses and attached events. Requires the following permission: 'Browse' on the specified project. For applications, it also requires 'Browse' permission on its child projects. Official SonarQube Web API endpoint: GET /api/project_analyses/s
sonarqube.sonarqube_project_analyses_update_event Write write 0 Update a project analysis event. Only events of category 'VERSION' and 'OTHER' can be updated. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified project; Official SonarQube Web API endpoint: POST /api/pro
sonarqube.sonarqube_project_badges_ai_code_assurance Read read 0 Generate a badge for project's AI assurance as an SVG. Requires 'Browse' permission on the specified project. Official SonarQube Web API endpoint: GET /api/project_badges/ai_code_assurance.
sonarqube.sonarqube_project_badges_measure Read read 0 Generate badge for project's measure as an SVG. Requires 'Browse' permission on the specified project. Official SonarQube Web API endpoint: GET /api/project_badges/measure.
sonarqube.sonarqube_project_badges_quality_gate Read read 0 Generate badge for project's quality gate as an SVG. Requires 'Browse' permission on the specified project. Official SonarQube Web API endpoint: GET /api/project_badges/quality_gate.
sonarqube.sonarqube_project_badges_renew_token Write write 0 Creates new token replacing any existing token for project or application badge access for private projects and applications. This token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints. Requires 'Admini
sonarqube.sonarqube_project_badges_token Read read 0 Retrieve a token to use for project or application badge access for private projects or applications. This token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints. Requires 'Browse' permission on the spec
sonarqube.sonarqube_project_branches_delete Write write 0 Delete a non-main branch of a project or application. Requires 'Administer' rights on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/delete.
sonarqube.sonarqube_project_branches_list Read read 0 List the branches of a project or application. Requires 'Browse' or 'Execute analysis' rights on the specified project or application. Official SonarQube Web API endpoint: GET /api/project_branches/list.
sonarqube.sonarqube_project_branches_rename Write write 0 Rename the main branch of a project or application. Requires 'Administer' permission on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/rename.
sonarqube.sonarqube_project_branches_set_automatic_deletion_protection Write write 0 Protect a specific branch from automatic deletion. Protection can't be disabled for the main branch. Requires 'Administer' permission on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/set_automatic_deleti
sonarqube.sonarqube_project_branches_set_main Write write 0 Allow to set a new main branch. . Caution, only applicable on projects. Requires 'Administer' rights on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/set_main.
sonarqube.sonarqube_project_dump_export Write write 0 Triggers project dump so that the project can be imported to another SonarQube server (see api/project_dump/import, available in Enterprise Edition). Requires the 'Administer' permission. Official SonarQube Web API endpoint: POST /api/project_dump/export.
sonarqube.sonarqube_project_dump_import Write write 0 Triggers the import of a project dump. Permission 'Administer' is required. This feature is provided by the Governance plugin. Official SonarQube Web API endpoint: POST /api/project_dump/import.
sonarqube.sonarqube_project_links_create Write write 0 Create a new project link. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: POST /api/project_links/create.
sonarqube.sonarqube_project_links_delete Write write 0 Delete existing project link. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: POST /api/project_links/delete.
sonarqube.sonarqube_project_links_search Read read 0 List links of a project. The 'projectId' or 'projectKey' must be provided. Requires one of the following permissions:- 'Administer System'; - 'Administer' rights on the specified project; - 'Browse' on the specified project; Official SonarQube Web API endpoin
sonarqube.sonarqube_project_pull_requests_delete Write write 0 Delete a pull request. Requires 'Administer' rights on the specified project. Official SonarQube Web API endpoint: POST /api/project_pull_requests/delete.
sonarqube.sonarqube_project_pull_requests_list Read read 0 List the pull requests of a project. One of the following permissions is required: - 'Browse' rights on the specified project; - 'Execute Analysis' rights on the specified project; Official SonarQube Web API endpoint: GET /api/project_pull_requests/list.
sonarqube.sonarqube_project_tags_search Read read 0 Search tags Official SonarQube Web API endpoint: GET /api/project_tags/search.
sonarqube.sonarqube_project_tags_set Write write 0 Set tags on a project. Requires the following permission: 'Administer' rights on the specified project Official SonarQube Web API endpoint: POST /api/project_tags/set.
sonarqube.sonarqube_projects_bulk_delete Write write 0 Delete one or several projects. Only the 1'000 first items in project filters are taken into account. Requires 'Administer System' permission. At least one parameter is required among analyzedBefore, projects and q Official SonarQube Web API endpoint: POST /a
sonarqube.sonarqube_projects_create Write write 0 Create a project. If your project is hosted on a DevOps Platform, please use the import endpoint under api/alm_integrations, so it creates and properly configures the project.Requires 'Create Projects' permission. Official SonarQube Web API endpoint: POST /ap
sonarqube.sonarqube_projects_delete Write write 0 Delete a project. Requires 'Administer System' permission or 'Administer' permission on the project. Official SonarQube Web API endpoint: POST /api/projects/delete.
sonarqube.sonarqube_projects_export_findings Read read 0 Export all findings (issues and hotspots) of a specific project branch. Requires 'Administer System' permission. Keep in mind that this endpoint will return all findings, issues and hotspots (no filter), which can take time and use a lot of resources on the So
sonarqube.sonarqube_projects_get_contains_ai_code Read read 0 Get whether a project contains AI code or not Official SonarQube Web API endpoint: GET /api/projects/get_contains_ai_code.
sonarqube.sonarqube_projects_license_usage Read read 0 Help admins to understand how much each project affects the total number of lines of code. Returns the list of projects together with information about their usage, sorted by lines of code descending. Requires Administer System permission. Official SonarQube
sonarqube.sonarqube_projects_search Read read 0 Search for projects or views to administrate them. - The response field 'lastAnalysisDate' takes into account the analysis of all branches and pull requests, not only the main branch.; - The response field 'revision' takes into account the analysis of the main
sonarqube.sonarqube_projects_set_contains_ai_code Write write 0 Sets if the project passed as parameter contains or not AI code according to the value of the contains_ai_code parameter. Requires 'Administer' rights on the specified project. Official SonarQube Web API endpoint: POST /api/projects/set_contains_ai_code.
sonarqube.sonarqube_projects_update_key Write write 0 Update a project all its sub-components keys. Requires 'Administer' permission on the project. Official SonarQube Web API endpoint: POST /api/projects/update_key.
sonarqube.sonarqube_projects_update_visibility Write write 0 Updates visibility of a project, application or a portfolio. Requires 'Project administer' permission on the specified entity Official SonarQube Web API endpoint: POST /api/projects/update_visibility.
sonarqube.sonarqube_qualitygates_add_group Write write 0 Allow a group of users to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/add_group.
sonarqube.sonarqube_qualitygates_add_user Write write 0 Allow a user to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/add_user.
sonarqube.sonarqube_qualitygates_copy Write write 0 Copy a Quality Gate. 'sourceName' must be provided. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/copy.
sonarqube.sonarqube_qualitygates_create Write write 0 Create a Quality Gate. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/create.
sonarqube.sonarqube_qualitygates_create_condition Write write 0 Add a new condition to a quality gate. Parameter 'gateName' must be provided. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/create_condition.
sonarqube.sonarqube_qualitygates_delete_condition Write write 0 Delete a condition from a quality gate. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/delete_condition.
sonarqube.sonarqube_qualitygates_deselect Write write 0 Remove the association of a project from a quality gate. Requires one of the following permissions:- 'Administer Quality Gates'; - 'Administer' rights on the project; Official SonarQube Web API endpoint: POST /api/qualitygates/deselect.
sonarqube.sonarqube_qualitygates_destroy Write write 0 Delete a Quality Gate. Parameter 'name' must be specified. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/destroy.
sonarqube.sonarqube_qualitygates_get_by_project Read read 0 Get the quality gate of a project. Requires one of the following permissions:- 'Administer System'; - 'Administer' rights on the specified project; - 'Browse' on the specified project; Official SonarQube Web API endpoint: GET /api/qualitygates/get_by_project.
sonarqube.sonarqube_qualitygates_list Read read 0 Get a list of quality gates Official SonarQube Web API endpoint: GET /api/qualitygates/list.
sonarqube.sonarqube_qualitygates_project_status Read read 0 Get the quality gate status of a project or a Compute Engine task. Either 'analysisId', 'projectId' or 'projectKey' must be provided The different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associate
sonarqube.sonarqube_qualitygates_remove_group Write write 0 Remove the ability from a group to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/remove_group.
sonarqube.sonarqube_qualitygates_remove_user Write write 0 Remove the ability from an user to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/remove_user.
sonarqube.sonarqube_qualitygates_rename Write write 0 Rename a Quality Gate. 'currentName' must be specified. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/rename.
sonarqube.sonarqube_qualitygates_search Read read 0 Search for projects associated (or not) to a quality gate. Only authorized projects for the current user will be returned. Official SonarQube Web API endpoint: GET /api/qualitygates/search.
sonarqube.sonarqube_qualitygates_search_groups Read read 0 List the groups that are allowed to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: GET /api/qualitygates/search_groups.
sonarqube.sonarqube_qualitygates_search_users Read read 0 List the users that are allowed to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: GET /api/qualitygates/search_users.
sonarqube.sonarqube_qualitygates_select Write write 0 Associate a project to a quality gate. Requires one of the following permissions: - 'Administer Quality Gates'; - 'Administer' right on the specified project; Official SonarQube Web API endpoint: POST /api/qualitygates/select.
sonarqube.sonarqube_qualitygates_set_as_default Write write 0 Set a quality gate as the default quality gate. Parameter 'name' must be specified. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/set_as_default.
sonarqube.sonarqube_qualitygates_show Read read 0 Display the details of a quality gate Official SonarQube Web API endpoint: GET /api/qualitygates/show.
sonarqube.sonarqube_qualitygates_update_condition Write write 0 Update a condition attached to a quality gate. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/update_condition.
sonarqube.sonarqube_qualityprofiles_activate_rule Write write 0 Activate a rule on a Quality Profile. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: POST /api/qualityprofiles/activate_rule.
sonarqube.sonarqube_qualityprofiles_activate_rules Write write 0 Bulk-activate rules on one quality profile. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: POST /api/qualityprofiles/activate_rules.
sonarqube.sonarqube_qualityprofiles_add_project Write write 0 Associate a project with a quality profile. Requires one of the following permissions: - 'Administer Quality Profiles'; - Administer right on the specified project; Official SonarQube Web API endpoint: POST /api/qualityprofiles/add_project.
sonarqube.sonarqube_qualityprofiles_backup Read read 0 Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore. Official SonarQube Web API endpoint: GET /api/qualityprofiles/backup.
sonarqube.sonarqube_qualityprofiles_change_parent Write write 0 Change a quality profile's parent. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: POST /api/qualityprofiles/change_parent.
sonarqube.sonarqube_qualityprofiles_changelog Read read 0 Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity/impacts. Events are ordered by date in descending order (most recent first). Official SonarQube Web API endpoint: GET /api/qualityprofiles/changelog.
sonarqube.sonarqube_qualityprofiles_copy Write write 0 Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarQube Web API endpoint: POST /api/qualityprofiles/copy.
sonarqube.sonarqube_qualityprofiles_create Write write 0 Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarQube Web API endpoint: POST /api/qualityprofiles/create.
sonarqube.sonarqube_qualityprofiles_deactivate_rule Write write 0 Deactivate a rule on a quality profile. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: POST /api/qualityprofiles/deactivate_rule.
sonarqube.sonarqube_qualityprofiles_deactivate_rules Write write 0 Bulk deactivate rules on Quality profiles. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: POST /api/qualityprofiles/deactivate_rules.
sonarqube.sonarqube_qualityprofiles_delete Write write 0 Delete a quality profile and all its descendants. The default quality profile cannot be deleted. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: PO
sonarqube.sonarqube_qualityprofiles_export Read read 0 Export a quality profile. Official SonarQube Web API endpoint: GET /api/qualityprofiles/export. Deprecated since SonarQube 25.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_qualityprofiles_exporters Read read 0 Deprecated. No more custom profile exporters. Official SonarQube Web API endpoint: GET /api/qualityprofiles/exporters. Deprecated since SonarQube 25.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_qualityprofiles_importers Read read 0 List supported importers. Official SonarQube Web API endpoint: GET /api/qualityprofiles/importers. Deprecated since SonarQube 25.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_qualityprofiles_inheritance Read read 0 Show a quality profile's ancestors and children. Official SonarQube Web API endpoint: GET /api/qualityprofiles/inheritance.
sonarqube.sonarqube_qualityprofiles_projects Read read 0 List projects with their association status regarding a quality profile. Only projects explicitly bound to the profile are returned, those associated with the profile because it is the default one are not. See api/qualityprofiles/search in order to get the Qua
sonarqube.sonarqube_qualityprofiles_remove_project Write write 0 Remove a project's association with a quality profile. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; - Administer right on the specified project; Official SonarQube Web API endpoint:
sonarqube.sonarqube_qualityprofiles_rename Write write 0 Rename a quality profile. Requires one of the following permissions: - 'Administer Quality Profiles'; - Edit right on the specified quality profile; Official SonarQube Web API endpoint: POST /api/qualityprofiles/rename.
sonarqube.sonarqube_qualityprofiles_restore Write write 0 Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile with the same name and language already exists, it will be overwritten. Requires to be logged in and the 'Administer Quality Profiles' permiss
sonarqube.sonarqube_qualityprofiles_search Read read 0 Search quality profiles Official SonarQube Web API endpoint: GET /api/qualityprofiles/search.
sonarqube.sonarqube_qualityprofiles_set_default Write write 0 Select the default profile for a given language. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarQube Web API endpoint: POST /api/qualityprofiles/set_default.
sonarqube.sonarqube_rules_create Write write 0 Create a custom rule. Requires the 'Administer Quality Profiles' permission Official SonarQube Web API endpoint: POST /api/rules/create.
sonarqube.sonarqube_rules_delete Write write 0 Delete custom rule. Requires the 'Administer Quality Profiles' permission Official SonarQube Web API endpoint: POST /api/rules/delete.
sonarqube.sonarqube_rules_repositories Read read 0 List available rule repositories Official SonarQube Web API endpoint: GET /api/rules/repositories.
sonarqube.sonarqube_rules_search Read read 0 Search for a collection of relevant rules matching a specified query. Official SonarQube Web API endpoint: GET /api/rules/search.
sonarqube.sonarqube_rules_show Read read 0 Get detailed information about a rule Official SonarQube Web API endpoint: GET /api/rules/show.
sonarqube.sonarqube_rules_tags Read read 0 List rule tags Official SonarQube Web API endpoint: GET /api/rules/tags.
sonarqube.sonarqube_rules_update Write write 0 Update an existing rule. Requires the 'Administer Quality Profiles' permission Official SonarQube Web API endpoint: POST /api/rules/update.
sonarqube.sonarqube_server_version Read read 0 Version of SonarQube in plain text Official SonarQube Web API endpoint: GET /api/server/version.
sonarqube.sonarqube_settings_list_definitions Read read 0 List settings definitions. Requires 'Browse' permission when a component is specified To access licensed settings, authentication is required To access secured settings, one of the following permissions is required: - 'Execute Analysis'; - 'Administer System';
sonarqube.sonarqube_settings_reset Write write 0 Remove a setting value. The settings defined in conf/sonar.properties are read-only and can't be changed. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified component; Official SonarQube Web API endpoint:
sonarqube.sonarqube_settings_set Write write 0 Update a setting value. Either 'value' or 'values' must be provided. The settings defined in conf/sonar.properties are read-only and can't be changed. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified comp
sonarqube.sonarqube_settings_values Read read 0 List settings values. If no value has been set for a setting, then the default value is returned. The settings from conf/sonar.properties are excluded from results. Requires 'Browse' or 'Execute Analysis' permission when a component is specified. Secured setti
sonarqube.sonarqube_sources_raw Read read 0 Get source code as raw text. Require 'See Source Code' permission on file Official SonarQube Web API endpoint: GET /api/sources/raw.
sonarqube.sonarqube_sources_scm Read read 0 Get SCM information of source files. Require See Source Code permission on file's project Each element of the result array is composed of:- Line number; - Author of the commit; - Datetime of the commit (before 5.2 it was only the Date); - Revision of the commi
sonarqube.sonarqube_sources_show Read read 0 Get source code. Requires See Source Code permission on file's project Each element of the result array is composed of:- Line number; - Content of the line; Official SonarQube Web API endpoint: GET /api/sources/show.
sonarqube.sonarqube_system_change_log_level Write write 0 Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission. Official SonarQube Web API endpoint: POST /api/system/change_log_level.
sonarqube.sonarqube_system_db_migration_status Read read 0 Display the database migration status of SonarQube. State values are:- NO_MIGRATION: DB is up to date with current version of SonarQube.; - NOT_SUPPORTED: Migration is not supported on embedded databases.; - MIGRATION_RUNNING: DB migration is under go.; - MIGR
sonarqube.sonarqube_system_health Read read 0 Provide health status of SonarQube.Although global health is calculated based on both application and search nodes, detailed information is returned only for application nodes. - GREEN: SonarQube is fully operational; - YELLOW: SonarQube is usable, but it need
sonarqube.sonarqube_system_info Read read 0 Get detailed information about system configuration. Requires 'Administer' permissions. Official SonarQube Web API endpoint: GET /api/system/info.
sonarqube.sonarqube_system_logs Read read 0 Get system logs in plain-text format. Requires system administration permission. Official SonarQube Web API endpoint: GET /api/system/logs.
sonarqube.sonarqube_system_migrate_db Write write 0 Migrate the database to match the current version of SonarQube. Sending a POST request to this URL starts the DB migration. It is strongly advised to make a database backup before invoking this WS. State values are:- NO_MIGRATION: DB is up to date with current
sonarqube.sonarqube_system_ping Read read 0 Answers "pong" as plain-text Official SonarQube Web API endpoint: GET /api/system/ping.
sonarqube.sonarqube_system_restart Write write 0 Restarts server. Requires 'Administer System' permission. Performs a full restart of the Web, Search and Compute Engine Servers processes. Does not reload sonar.properties. Official SonarQube Web API endpoint: POST /api/system/restart.
sonarqube.sonarqube_system_status Read read 0 Get state information about SonarQube.status: the running status - STARTING: SonarQube Web Server is up and serving some Web Services (eg. api/system/status) but initialization is still ongoing; - UP: SonarQube instance is up and running; - DOWN: SonarQube ins
sonarqube.sonarqube_system_upgrades Read read 0 Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade. Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in
sonarqube.sonarqube_user_groups_add_user Write write 0 Add a user to a group. 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/add_user. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose i
sonarqube.sonarqube_user_groups_create Write write 0 Create a group. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/create. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_user_groups_delete Write write 0 Delete a group. The default groups cannot be deleted. 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/delete. Deprecated since SonarQube 10.4; kept for API parity wit
sonarqube.sonarqube_user_groups_remove_user Write write 0 Remove a user from a group. 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/remove_user. Deprecated since SonarQube 10.4; kept for API parity with servers that still
sonarqube.sonarqube_user_groups_search Read read 0 Search for user groups. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: GET /api/user_groups/search. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_user_groups_update Write write 0 Update a group. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/update. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_user_groups_users Read read 0 Search for users with membership information with respect to a group. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: GET /api/user_groups/users. Deprecated since SonarQube 10.4; kept for API parity with servers t
sonarqube.sonarqube_user_tokens_generate Write write 0 Generate a user access token. Please keep your tokens secret. They enable to authenticate and analyze projects. It requires administration permissions to specify a 'login' and generate a token for another user. Otherwise, a token is generated for the current u
sonarqube.sonarqube_user_tokens_revoke Write write 0 Revoke a user access token. It requires administration permissions to specify a 'login' and revoke a token for another user. Otherwise, the token for the current user is revoked. Official SonarQube Web API endpoint: POST /api/user_tokens/revoke.
sonarqube.sonarqube_user_tokens_search Read read 0 List the access tokens of a user. The login must exist and active. Field 'lastConnectionDate' is only updated every hour, so it may not be accurate, for instance when a user is using a token many times in less than one hour. It requires administration permissi
sonarqube.sonarqube_users_anonymize Write write 0 Anonymize a deactivated user. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/anonymize. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_users_change_password Write write 0 Update a user's password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user's password. Official SonarQube Web API e
sonarqube.sonarqube_users_create Write write 0 Create a user. If a deactivated user account exists with the given login, it will be reactivated. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/create. Deprecated since SonarQube 10.4; kept for API parity with ser
sonarqube.sonarqube_users_deactivate Write write 0 Deactivate a user. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/deactivate. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_users_groups Read read 0 Lists the groups a user belongs to. Requires Administer System permission. Official SonarQube Web API endpoint: GET /api/users/groups. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_users_search Read read 0 Get a list of users. By default, only active users are returned. The following fields are only returned when user has Administer System permission or for logged-in in user : - 'email'; - 'externalIdentity'; - 'externalProvider'; - 'groups'; - 'lastConnectionDa
sonarqube.sonarqube_users_update Write write 0 Update a user. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/update. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_users_update_identity_provider Write write 0 Update identity provider information. It's only possible to migrate to an installed identity provider. Be careful that as soon as this information has been updated for a user, the user will only be able to authenticate on the new identity provider. It is not p
sonarqube.sonarqube_users_update_login Write write 0 Update a user login. A login can be updated many times. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/update_login. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
sonarqube.sonarqube_views_add_application Write write 0 Add an existing application to a portfolio. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: POST /api/views/add_application.
sonarqube.sonarqube_views_add_application_branch Write write 0 Add a branch of an application selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the application. Official SonarQube Web API endpoint: POST /api/views/add_application_branch.
sonarqube.sonarqube_views_add_portfolio Write write 0 Add an existing portfolio to the structure of another portfolio. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: POST /api/views/add_portfolio.
sonarqube.sonarqube_views_add_project Write write 0 Add a project to a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for adding project. Official SonarQube Web API endpoint: POST /api/views/add_project.
sonarqube.sonarqube_views_add_project_branch Write write 0 Add a branch of a project selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the project. Official SonarQube Web API endpoint: POST /api/views/add_project_branch.
sonarqube.sonarqube_views_applications Read read 0 List applications which the user has access to that can be added to a portfolio. Authentication is required for this API endpoint Official SonarQube Web API endpoint: GET /api/views/applications.
sonarqube.sonarqube_views_create Write write 0 Create a new portfolio. Requires 'Administer System' permission or 'Create Portfolios' permission, Official SonarQube Web API endpoint: POST /api/views/create.
sonarqube.sonarqube_views_delete Write write 0 Delete a portfolio definition. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/delete.
sonarqube.sonarqube_views_list Read read 0 List root portfolios. Requires authentication. Only portfolios with the admin permission are returned. Official SonarQube Web API endpoint: GET /api/views/list.
sonarqube.sonarqube_views_move Write write 0 Move a portfolio. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: POST /api/views/move.
sonarqube.sonarqube_views_move_options Read read 0 List possible portfolio destinations. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: GET /api/views/move_options.
sonarqube.sonarqube_views_portfolios Read read 0 List portfolios that can be referenced. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: GET /api/views/portfolios.
sonarqube.sonarqube_views_remove_application Write write 0 Remove an application from a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/remove_application.
sonarqube.sonarqube_views_remove_application_branch Write write 0 Remove a branch of an application selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the application. Official SonarQube Web API endpoint: POST /api/views/remove_application_branch.
sonarqube.sonarqube_views_remove_portfolio Write write 0 Remove a reference to a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/remove_portfolio.
sonarqube.sonarqube_views_remove_project Write write 0 Remove a project from a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/remove_project.
sonarqube.sonarqube_views_remove_project_branch Write write 0 Remove a branch of a project selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the project. Official SonarQube Web API endpoint: POST /api/views/remove_project_branch.
sonarqube.sonarqube_views_set_manual_mode Write write 0 Set the projects selection mode of a portfolio on manual selection. In order to add project, please use api/view/add_project. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_manual_mode.
sonarqube.sonarqube_views_set_none_mode Write write 0 Set the projects selection mode of a portfolio to none. After setting this mode portfolio will not have any projects assigned. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_none_mode.
sonarqube.sonarqube_views_set_regexp_mode Write write 0 Set the projects selection mode of a portfolio on regular expression. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_regexp_mode.
sonarqube.sonarqube_views_set_remaining_projects_mode Write write 0 Set the projects selection mode of a portfolio on unassociated projects in hierarchy. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_remaining_projects_mode.
sonarqube.sonarqube_views_set_tags_mode Write write 0 Set the projects selection mode of a portfolio on project tags. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_tags_mode.
sonarqube.sonarqube_views_show Read read 0 Show the details of a portfolio, including its hierarchy and project selection mode. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: GET /api/views/show.
sonarqube.sonarqube_views_update Write write 0 Update a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/update.
sonarqube.sonarqube_webhooks_create Write write 0 Create a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: POST /api/webhooks/create.
sonarqube.sonarqube_webhooks_delete Write write 0 Delete a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: POST /api/webhooks/delete.
sonarqube.sonarqube_webhooks_deliveries Read read 0 Get the recent deliveries for a specified project or Compute Engine task. Require 'Administer' permission on the related project. Note that additional information are returned by api/webhooks/delivery. Official SonarQube Web API endpoint: GET /api/webhooks/de
sonarqube.sonarqube_webhooks_delivery Read read 0 Get a webhook delivery by its id. Require 'Administer System' permission. Note that additional information are returned by api/webhooks/delivery. Official SonarQube Web API endpoint: GET /api/webhooks/delivery.
sonarqube.sonarqube_webhooks_list Read read 0 Search for global webhooks or project webhooks. Webhooks are ordered by name. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: GET /api/webhooks/list.
sonarqube.sonarqube_webhooks_update Write write 0 Update a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: POST /api/webhooks/update.
sonarqube.sonarqube_webservices_list Read read 0 List web services Official SonarQube Web API endpoint: GET /api/webservices/list.
sonarqube.sonarqube_webservices_response_example Read read 0 Display web service response example Official SonarQube Web API endpoint: GET /api/webservices/response_example.