KosmoKrator

data

SonarCloud MCP, CLI, and Lua Integration for AI Agents

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

SonarCloud 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

Machine-Readable Metadata

Function Catalog

FunctionTypeParametersDescription
sonarcloud.sonarcloud_authentication_logout Write write 0 Logout a user. Official SonarCloud Web API endpoint: POST /api/authentication/logout.
sonarcloud.sonarcloud_authentication_validate Read read 0 Check credentials. Returns true for anonymous user. Official SonarCloud Web API endpoint: GET /api/authentication/validate.
sonarcloud.sonarcloud_ce_activity Read read 0 Search for tasks. Either componentId or component can be provided, but not both. Requires the project administration permission if componentId or component is set. Official SonarCloud Web API endpoint: GET /api/ce/activity.
sonarcloud.sonarcloud_ce_activity_status Read read 0 Returns CE activity related metrics. Requires 'Administer' permission on the specified project. Official SonarCloud Web API endpoint: GET /api/ce/activity_status.
sonarcloud.sonarcloud_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. Either 'componentId' or 'component' must be provided. Official SonarCloud Web
sonarcloud.sonarcloud_ce_task Read read 0 Give Compute Engine task details such as type, status, duration and associated component. Requires 'Execute Analysis' permission. Official SonarCloud Web API endpoint: GET /api/ce/task.
sonarcloud.sonarcloud_components_search Read read 0 Search for projects. Used to provide the ability to search for any component but this option has been removed and webservice 'api/components/tree' should be used instead for this purpose Official SonarCloud Web API endpoint: GET /api/components/search.
sonarcloud.sonarcloud_components_show Read read 0 Returns a component (file, directory, project) 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 SonarCloud Web API endpoint: GET /
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: GET /api/components/
sonarcloud.sonarcloud_duplications_show Read read 0 Get duplications. Require Browse permission on file's project Official SonarCloud Web API endpoint: GET /api/duplications/show.
sonarcloud.sonarcloud_favorites_add Write write 0 Add a project as favorite for the authenticated user. Only 100 components can be added as favorite. Requires authentication and the following permission: 'Browse' on the project. Official SonarCloud Web API endpoint: POST /api/favorites/add.
sonarcloud.sonarcloud_favorites_remove Write write 0 Remove a component (project, directory, file etc.) as favorite for the authenticated user. Requires authentication. Official SonarCloud Web API endpoint: POST /api/favorites/remove.
sonarcloud.sonarcloud_favorites_search Read read 0 Search for the authenticated user favorites. Requires authentication. Official SonarCloud Web API endpoint: GET /api/favorites/search.
sonarcloud.sonarcloud_favourites_index Read read 0 The web service is removed and you're invited to use api/favorites instead Official SonarCloud Web API endpoint: GET /api/favourites/index. Deprecated since SonarCloud 6.3; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_hotspots_change_status Write write 0 Change the status of a Security Hotpot. Requires the 'Administer Security Hotspot' permission. Official SonarCloud Web API endpoint: POST /api/hotspots/change_status.
sonarcloud.sonarcloud_hotspots_search Read read 0 Search for Security Hotpots. Official SonarCloud Web API endpoint: GET /api/hotspots/search.
sonarcloud.sonarcloud_hotspots_show Read read 0 Provides the details of a Security Hotspot. Official SonarCloud Web API endpoint: GET /api/hotspots/show.
sonarcloud.sonarcloud_issues_add_comment Write write 0 Add a comment. Requires authentication and the following permission: 'Browse' on the project of the specified issue. Official SonarCloud Web API endpoint: POST /api/issues/add_comment.
sonarcloud.sonarcloud_issues_assign Write write 0 Assign/Unassign an issue. Requires authentication and Browse permission on project Official SonarCloud Web API endpoint: POST /api/issues/assign.
sonarcloud.sonarcloud_issues_authors Read read 0 Search SCM accounts which match a given query. Requires authentication. Official SonarCloud Web API endpoint: GET /api/issues/authors.
sonarcloud.sonarcloud_issues_bulk_change Write write 0 Bulk change on issues. Requires authentication. Official SonarCloud Web API endpoint: POST /api/issues/bulk_change.
sonarcloud.sonarcloud_issues_changelog Read read 0 Display changelog of an issue. Requires the 'Browse' permission on the project of the specified issue. Official SonarCloud Web API endpoint: GET /api/issues/changelog.
sonarcloud.sonarcloud_issues_delete_comment Write write 0 Delete a comment. Requires authentication and the following permission: 'Browse' on the project of the specified issue. Official SonarCloud Web API endpoint: POST /api/issues/delete_comment.
sonarcloud.sonarcloud_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 permissio
sonarcloud.sonarcloud_issues_edit_comment Write write 0 Edit a comment. Requires authentication and the following permission: 'Browse' on the project of the specified issue. Official SonarCloud Web API endpoint: POST /api/issues/edit_comment.
sonarcloud.sonarcloud_issues_search Read read 0 Search for issues. Requires the 'Browse' permission on the specified project(s). Official SonarCloud Web API endpoint: GET /api/issues/search.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/issues/set_severity.
sonarcloud.sonarcloud_issues_set_tags Write write 0 Set tags on an issue. Requires authentication and Browse permission on project Official SonarCloud Web API endpoint: POST /api/issues/set_tags.
sonarcloud.sonarcloud_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 SonarCloud Web
sonarcloud.sonarcloud_issues_tags Read read 0 List tags matching a given query Official SonarCloud Web API endpoint: GET /api/issues/tags.
sonarcloud.sonarcloud_languages_list Read read 0 List supported programming languages Official SonarCloud Web API endpoint: GET /api/languages/list.
sonarcloud.sonarcloud_measures_component Read read 0 Return component with specified measures. The componentId or the component parameter must be provided. Requires the following permission: 'Browse' on the project of specified component. Official SonarCloud Web API endpoint: GET /api/measures/component.
sonarcloud.sonarcloud_measures_component_tree Read read 0 Navigate through components based on the chosen strategy with specified measures. The baseComponentId or the component parameter must be provided. Requires the following permission: 'Browse' on the specified project. When limiting search with the q parameter,
sonarcloud.sonarcloud_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 Official SonarCloud Web API endpoint: GET /api/m
sonarcloud.sonarcloud_metrics_domains Read read 0 List all custom metric domains. Official SonarCloud Web API endpoint: GET /api/metrics/domains. Deprecated since SonarCloud 7.7; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_metrics_search Read read 0 Search for metrics Official SonarCloud Web API endpoint: GET /api/metrics/search.
sonarcloud.sonarcloud_metrics_types Read read 0 List all available metric types. Official SonarCloud Web API endpoint: GET /api/metrics/types.
sonarcloud.sonarcloud_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.; - If a project is provided, requires the '
sonarcloud.sonarcloud_notifications_list Read read 0 List notifications of the authenticated user Official SonarCloud Web API endpoint: GET /api/notifications/list.
sonarcloud.sonarcloud_notifications_remove Write write 0 Remove a notification for the authenticated user Official SonarCloud Web API endpoint: POST /api/notifications/remove.
sonarcloud.sonarcloud_permissions_add_group Write write 0 Add 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 or group id must be provided. Requires the permission 'Administer' on the specified project
sonarcloud.sonarcloud_permissions_add_group_to_template Write write 0 Add a group to a permission template. The group id or group name must be provided. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/add_group_to_template.
sonarcloud.sonarcloud_permissions_add_project_creator_to_template Write write 0 Add a project creator to a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/add_project_creator_to_template.
sonarcloud.sonarcloud_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 the permission 'Administer' on the specified project. Official SonarCloud Web API endpoint: POST
sonarcloud.sonarcloud_permissions_add_user_to_template Write write 0 Add a user to a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/add_user_to_template.
sonarcloud.sonarcloud_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 permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/apply_t
sonarcloud.sonarcloud_permissions_bulk_apply_template Write write 0 Apply a permission template to several projects. The template id or name must be provided. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/bulk_apply_template.
sonarcloud.sonarcloud_permissions_create_template Write write 0 Create a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/create_template.
sonarcloud.sonarcloud_permissions_delete_template Write write 0 Delete a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/delete_template.
sonarcloud.sonarcloud_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 id or group name must be provided, not both. Requires the permission 'Administer' on the
sonarcloud.sonarcloud_permissions_remove_group_from_template Write write 0 Remove a group from a permission template. The group id or group name must be provided. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/remove_group_from_template.
sonarcloud.sonarcloud_permissions_remove_project_creator_from_template Write write 0 Remove a project creator from a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/remove_project_creator_from_template.
sonarcloud.sonarcloud_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 the permission 'Administer' on the specified project. Official SonarCloud Web API endpoint:
sonarcloud.sonarcloud_permissions_remove_user_from_template Write write 0 Remove a user from a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/remove_user_from_template.
sonarcloud.sonarcloud_permissions_search_templates Read read 0 List permission templates. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: GET /api/permissions/search_templates.
sonarcloud.sonarcloud_permissions_set_default_template Write write 0 Set a permission template as default. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/set_default_template.
sonarcloud.sonarcloud_permissions_update_template Write write 0 Update a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/update_template.
sonarcloud.sonarcloud_project_analyses_create_event Write write 0 Create a project analysis event. Only event of category 'VERSION' and 'OTHER' can be created. Requires the permission 'Administer' on the specified project. Official SonarCloud Web API endpoint: POST /api/project_analyses/create_event.
sonarcloud.sonarcloud_project_analyses_delete Write write 0 Delete a project analysis. Requires the permission 'Administer' on the project of the specified analysis. Official SonarCloud Web API endpoint: POST /api/project_analyses/delete.
sonarcloud.sonarcloud_project_analyses_delete_event Write write 0 Delete a project analysis event. Only event of category 'VERSION' and 'OTHER' can be deleted. Requires the permission 'Administer' on the specified project. Official SonarCloud Web API endpoint: POST /api/project_analyses/delete_event.
sonarcloud.sonarcloud_project_analyses_search Read read 0 Search a project analyses and attached events. Requires the following permission: 'Browse' on the specified project Official SonarCloud Web API endpoint: GET /api/project_analyses/search.
sonarcloud.sonarcloud_project_analyses_set_baseline Write write 0 Set an analysis as the baseline of the New Code Period on a project or a long-lived branch. This manually set baseline overrides the `sonar.leak.period` setting. Requires the permission 'Administer' on the specified project. Official SonarCloud Web API endpoi
sonarcloud.sonarcloud_project_analyses_unset_baseline Write write 0 Unset any manually-set New Code Period baseline on a project or a long-lived branch. Unsetting a manual baseline restores the use of the `sonar.leak.period` setting. Requires the permission 'Administer' on the specified project. Official SonarCloud Web API en
sonarcloud.sonarcloud_project_analyses_update_event Write write 0 Update a project analysis event. Only events of category 'VERSION' and 'OTHER' can be updated. Requires the permission 'Administer' on the specified project. Official SonarCloud Web API endpoint: POST /api/project_analyses/update_event.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: GET /api/project_badges/ai_code_assurance.
sonarcloud.sonarcloud_project_badges_measure Read read 0 Generate badge for project's measure as an SVG. Requires a security token for private projects. Official SonarCloud Web API endpoint: GET /api/project_badges/measure.
sonarcloud.sonarcloud_project_badges_quality_gate Read read 0 Generate badge for project's quality gate as an SVG. Requires a security token for private projects. Official SonarCloud Web API endpoint: GET /api/project_badges/quality_gate.
sonarcloud.sonarcloud_project_branches_delete Write write 0 Delete a non-main branch of a project. Requires 'Administer' rights on the specified project. Official SonarCloud Web API endpoint: POST /api/project_branches/delete.
sonarcloud.sonarcloud_project_branches_list Read read 0 List the branches of a project. The statistics are the overall counts on long branches, and the count of issues detected on the changed code on short branches, and are only provided if the project parameter is specified. If the project parameter is specified,
sonarcloud.sonarcloud_project_branches_rename Write write 0 Rename the main branch of a project. Requires 'Administer' permission on the specified project. Official SonarCloud Web API endpoint: POST /api/project_branches/rename.
sonarcloud.sonarcloud_project_links_create Write write 0 Create a new project link. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarCloud Web API endpoint: POST /api/project_links/create.
sonarcloud.sonarcloud_project_links_delete Write write 0 Delete existing project link. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarCloud Web API endpoint: POST /api/project_links/delete.
sonarcloud.sonarcloud_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' rights on the specified project; - 'Browse' on the specified project; Official SonarCloud Web API endpoint: GET /api/project_li
sonarcloud.sonarcloud_project_pull_requests_delete Write write 0 Delete a pull request. Requires 'Administer' rights on the specified project. Official SonarCloud Web API endpoint: POST /api/project_pull_requests/delete.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: GET /api/project_pull_requests/list.
sonarcloud.sonarcloud_project_tags_search Read read 0 Search tags Official SonarCloud Web API endpoint: GET /api/project_tags/search.
sonarcloud.sonarcloud_project_tags_set Write write 0 Set tags on a project. Requires the following permission: 'Administer' rights on the specified project Official SonarCloud Web API endpoint: POST /api/project_tags/set.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /
sonarcloud.sonarcloud_projects_bulk_update_key Write write 0 Bulk update a project or module key and all its sub-components keys. The bulk update allows to replace a part of the current key by another string on the current project and all its sub-modules. It's possible to simulate the bulk update by setting the paramete
sonarcloud.sonarcloud_projects_create Write write 0 Create a project. Requires 'Create Projects' permission Official SonarCloud Web API endpoint: POST /api/projects/create.
sonarcloud.sonarcloud_projects_delete Write write 0 Delete a project. Requires 'Administer System' permission or 'Administer' permission on the project. Official SonarCloud Web API endpoint: POST /api/projects/delete.
sonarcloud.sonarcloud_projects_search Read read 0 Search for projects to administrate them. Requires 'System Administrator' permission Official SonarCloud Web API endpoint: GET /api/projects/search.
sonarcloud.sonarcloud_projects_update_key Write write 0 Update a project or module key and all its sub-components keys. Requires the permission 'Administer' on the specified project. Official SonarCloud Web API endpoint: POST /api/projects/update_key.
sonarcloud.sonarcloud_projects_update_visibility Write write 0 Updates visibility of a project. Requires 'Project administer' permission on the specified project Official SonarCloud Web API endpoint: POST /api/projects/update_visibility.
sonarcloud.sonarcloud_properties_index Read read 0 This web service is deprecated, please use api/settings/values instead. Official SonarCloud Web API endpoint: GET /api/properties/index. Deprecated since SonarCloud 6.3; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_copy Write write 0 Copy a Quality Gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/copy. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_create Write write 0 Create a Quality Gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/create. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_create_condition Write write 0 Add a new condition to a quality gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/create_condition. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official r
sonarcloud.sonarcloud_qualitygates_delete_condition Write write 0 Delete a condition from a quality gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/delete_condition. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualitygates/deselect. Deprecated since Son
sonarcloud.sonarcloud_qualitygates_destroy Write write 0 Delete a Quality Gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/destroy. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_get_by_project Read read 0 Get the quality gate of a project. Requires one of the following permissions:- 'Administer' rights on the specified project; - 'Browse' on the specified project; Official SonarCloud Web API endpoint: GET /api/qualitygates/get_by_project. Deprecated since Son
sonarcloud.sonarcloud_qualitygates_list Read read 0 Get a list of quality gates Official SonarCloud Web API endpoint: GET /api/qualitygates/list. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_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
sonarcloud.sonarcloud_qualitygates_rename Write write 0 Rename a Quality Gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/rename. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_search Read read 0 Search for projects associated (or not) to a quality gate. Only authorized projects for current user will be returned. Official SonarCloud Web API endpoint: GET /api/qualitygates/search. Deprecated since SonarCloud 16 September, 2025; kept for API parity whi
sonarcloud.sonarcloud_qualitygates_select Write write 0 Associate a project to a quality gate. The 'projectId' or 'projectKey' must be provided. Project id as a numeric value is deprecated since 6.1. Please use the id similar to 'AU-TpxcA-iU5OvuD2FLz'. Requires the 'Administer Quality Gates' permission. Official S
sonarcloud.sonarcloud_qualitygates_set_as_default Write write 0 Set a quality gate as the default quality gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/set_as_default. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the off
sonarcloud.sonarcloud_qualitygates_show Read read 0 Display the details of a quality gate Official SonarCloud Web API endpoint: GET /api/qualitygates/show. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_unset_default Write write 0 This webservice is no more available : a default quality gate is mandatory. Official SonarCloud Web API endpoint: POST /api/qualitygates/unset_default. Deprecated since SonarCloud 7.0; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualitygates_update_condition Write write 0 Update a condition attached to a quality gate. Requires the 'Administer Quality Gates' permission. Official SonarCloud Web API endpoint: POST /api/qualitygates/update_condition. Deprecated since SonarCloud 16 September, 2025; kept for API parity while the of
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/activate_rule.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/activate_rules.
sonarcloud.sonarcloud_qualityprofiles_add_project Write write 0 Associate a project 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 SonarCloud Web API endpoint: POST /api
sonarcloud.sonarcloud_qualityprofiles_backup Read read 0 Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore. Official SonarCloud Web API endpoint: GET /api/qualityprofiles/backup.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/change_parent.
sonarcloud.sonarcloud_qualityprofiles_changelog Read read 0 Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first). Official SonarCloud Web API endpoint: GET /api/qualityprofiles/changelog.
sonarcloud.sonarcloud_qualityprofiles_copy Write write 0 Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarCloud Web API endpoint: POST /api/qualityprofiles/copy.
sonarcloud.sonarcloud_qualityprofiles_create Write write 0 Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarCloud Web API endpoint: POST /api/qualityprofiles/create.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/deactivate_rule.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/deactivate_rules.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: P
sonarcloud.sonarcloud_qualityprofiles_export Read read 0 Deprecated. Use GET /api/qualityprofiles/backup instead Official SonarCloud Web API endpoint: GET /api/qualityprofiles/export. Deprecated since SonarCloud 18 March, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualityprofiles_exporters Read read 0 Deprecated. No more custom profile exporters. Official SonarCloud Web API endpoint: GET /api/qualityprofiles/exporters. Deprecated since SonarCloud 18 March, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualityprofiles_importers Read read 0 Deprecated. No more custom profile importers. Official SonarCloud Web API endpoint: GET /api/qualityprofiles/importers. Deprecated since SonarCloud 18 March, 2025; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_qualityprofiles_inheritance Read read 0 Show a quality profile's ancestors and children. Official SonarCloud Web API endpoint: GET /api/qualityprofiles/inheritance.
sonarcloud.sonarcloud_qualityprofiles_projects Read read 0 List projects with their association status regarding a quality profile Official SonarCloud Web API endpoint: GET /api/qualityprofiles/projects.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/rename.
sonarcloud.sonarcloud_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
sonarcloud.sonarcloud_qualityprofiles_restore_built_in Write write 0 This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are automatically updated and read only. Returns HTTP code 410. Official SonarCloud Web API endpoint: POST /api/qualityprofiles/restore_built_in.
sonarcloud.sonarcloud_qualityprofiles_search Read read 0 Search quality profiles Official SonarCloud Web API endpoint: GET /api/qualityprofiles/search.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: POST /api/qualityprofiles/set_default.
sonarcloud.sonarcloud_rules_repositories Read read 0 List available rule repositories Official SonarCloud Web API endpoint: GET /api/rules/repositories.
sonarcloud.sonarcloud_rules_search Read read 0 Search for a collection of relevant rules matching a specified query. Since 5.5, following fields in the response have been deprecated :- "effortToFixDescription" becomes "gapDescription"; - "debtRemFnCoeff" becomes "remFnGapMultiplier"; - "defaultDebtRemFnCoe
sonarcloud.sonarcloud_rules_show Read read 0 Get detailed information about a rule Since 5.5, following fields in the response have been deprecated :- "effortToFixDescription" becomes "gapDescription"; - "debtRemFnCoeff" becomes "remFnGapMultiplier"; - "defaultDebtRemFnCoeff" becomes "defaultRemFnGapMult
sonarcloud.sonarcloud_rules_tags Read read 0 List rule tags Official SonarCloud Web API endpoint: GET /api/rules/tags.
sonarcloud.sonarcloud_rules_update Write write 0 Update an existing rule. Requires the 'Administer Quality Profiles' permission Official SonarCloud Web API endpoint: POST /api/rules/update.
sonarcloud.sonarcloud_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' rights
sonarcloud.sonarcloud_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 the permission 'Administer' on the specified component. Official SonarCloud Web API endpoint: POST /api/settings/reset.
sonarcloud.sonarcloud_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 the permission 'Administer' on the specified component. Official SonarCloud Web API endpoint: POST
sonarcloud.sonarcloud_settings_values Read read 0 List settings values. If no value has been set for a setting, then the default value is returned. Both component and organization parameters cannot be used together. Requires 'Browse' or 'Execute Analysis' permission when a component is specified. Requires to
sonarcloud.sonarcloud_sources_raw Read read 0 Get source code as raw text. Require 'See Source Code' permission on file Official SonarCloud Web API endpoint: GET /api/sources/raw.
sonarcloud.sonarcloud_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
sonarcloud.sonarcloud_sources_show Read read 0 Get source code. Requires See Source Code permission on file's project, or organization membership on public projects. Each element of the result array is composed of:- Line number; - Content of the line; Official SonarCloud Web API endpoint: GET /api/sources
sonarcloud.sonarcloud_timemachine_index Read read 0 The web service is removed and you're invited to use api/measures/search_history instead Official SonarCloud Web API endpoint: GET /api/timemachine/index. Deprecated since SonarCloud 6.3; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_user_groups_add_user Write write 0 Add a user to a group. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/add_user.
sonarcloud.sonarcloud_user_groups_create Write write 0 Create a group. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/create.
sonarcloud.sonarcloud_user_groups_delete Write write 0 Delete a group. The default groups cannot be deleted. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/delete.
sonarcloud.sonarcloud_user_groups_remove_user Write write 0 Remove a user from a group. 'id' or 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/remove_user.
sonarcloud.sonarcloud_user_groups_search Read read 0 Search for user groups. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: GET /api/user_groups/search.
sonarcloud.sonarcloud_user_groups_update Write write 0 Update a group. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/update.
sonarcloud.sonarcloud_user_groups_users Read read 0 Search for users with membership information with respect to a group. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: GET /api/user_groups/users.
sonarcloud.sonarcloud_user_properties_index Read read 0 This web service is removed Official SonarCloud Web API endpoint: GET /api/user_properties/index. Deprecated since SonarCloud 6.3; kept for API parity while the official registry still exposes it.
sonarcloud.sonarcloud_user_tokens_generate Write write 0 Generate a user access token. Please keep your tokens secret. They enable to authenticate and analyze projects. The endpoint generates a token for the logged in user. Official SonarCloud Web API endpoint: POST /api/user_tokens/generate.
sonarcloud.sonarcloud_user_tokens_revoke Write write 0 Revoke an access token of the authenticated user. Official SonarCloud Web API endpoint: POST /api/user_tokens/revoke.
sonarcloud.sonarcloud_user_tokens_search Read read 0 List the access tokens of the authenticated user. 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. Official SonarCloud Web API endpoint: GET /api/user
sonarcloud.sonarcloud_users_groups Read read 0 Lists the groups a user belongs to. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: GET /api/users/groups.
sonarcloud.sonarcloud_webhooks_create Write write 0 Create a Webhook. Requires 'Administer' permission on the specified project. Official SonarCloud Web API endpoint: POST /api/webhooks/create.
sonarcloud.sonarcloud_webhooks_delete Write write 0 Delete a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarCloud Web API endpoint: POST /api/webhooks/delete.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: GET /api/webhooks/d
sonarcloud.sonarcloud_webhooks_delivery Read read 0 Get a webhook delivery by its id. Note that additional information are returned by api/webhooks/delivery. Official SonarCloud Web API endpoint: GET /api/webhooks/delivery.
sonarcloud.sonarcloud_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 SonarCloud Web API endpoint: GET /api/webhooks/list.
sonarcloud.sonarcloud_webhooks_update Write write 0 Update a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarCloud Web API endpoint: POST /api/webhooks/update.
sonarcloud.sonarcloud_webservices_list Read read 0 List web services Official SonarCloud Web API endpoint: GET /api/webservices/list.
sonarcloud.sonarcloud_webservices_response_example Read read 0 Display web service response example Official SonarCloud Web API endpoint: GET /api/webservices/response_example.