> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SonarQube Cloud

> How to set up the SonarQube Cloud connector, plus the actions and events that are available.

![SonarQube Cloud](https://stackone-logos.com/api/sonarcloud/filled/svg)

Previewv1.3.1[See changelog](https://docs.stackone.com/connectors/sonarcloud/changelog.md)

[104 actions](#actions) · [6 events](#events) · 1 auth method

Developer Tools
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal Access Token (Bearer) · Connector Profile](https://docs.stackone.com/connectors/sonarcloud/guides/connector-profile/personal-access-token-bearer.md)
>
> Uses a SonarQube Cloud Personal Access Token, which expires 60 days after its last use. The token carries every permissi...

Optionally, configure receiving Events for SonarQube Cloud into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/sonarcloud/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal Access Token (Bearer) · Link Account](https://docs.stackone.com/connectors/sonarcloud/guides/link-account/personal-access-token-bearer.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

104 actions

ActionDescription

Authentication Logout`sonarcloud_authentication_logout`

Logout a user.

Authentication Validate`sonarcloud_authentication_validate`

Check credentials. Returns true for anonymous user.

Ce Activity Status`sonarcloud_ce_activity_status`

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

Ce Component`sonarcloud_ce_component`

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

Components Search`sonarcloud_components_search`

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

Components Show`sonarcloud_components_show`

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

Components Tree`sonarcloud_components_tree`

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

Duplications Show`sonarcloud_duplications_show`

Get duplications. Require Browse permission on file's project

Favorites Add`sonarcloud_favorites_add`

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

Favorites Remove`sonarcloud_favorites_remove`

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

Favorites Search`sonarcloud_favorites_search`

Search for the authenticated user favorites.Requires authentication.

Hotspots Search`sonarcloud_hotspots_search`

Search for Security Hotspots.

Get Unified Credentials`sonarcloud_unified_get_me`

Get the current SonarQube Cloud connection's unified credentials and identity.

List Unified Groups`sonarcloud_unified_list_groups`

List unified groups in SonarQube Cloud.

Get Unified Group`sonarcloud_unified_get_group`

Get a unified SonarQube Cloud group by id.

List Unified Organizations`sonarcloud_unified_list_organizations`

List unified organizations in SonarQube Cloud.

Get Unified Organization`sonarcloud_unified_get_organization`

Get a unified SonarQube Cloud organization by id.

List Unified Roles`sonarcloud_unified_list_roles`

List unified roles in SonarQube Cloud.

Get Unified Role`sonarcloud_unified_get_role`

Get a unified SonarQube Cloud role by ID.

List Unified Users`sonarcloud_unified_list_users`

List unified users in SonarQube Cloud.

Get Unified User`sonarcloud_unified_get_user`

Get a unified SonarQube Cloud user by id.

Issues Authors`sonarcloud_issues_authors`

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

Issues Search`sonarcloud_issues_search`

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

Issues Tags`sonarcloud_issues_tags`

List tags matching a given query

Languages List`sonarcloud_languages_list`

List supported programming languages

Measures Component`sonarcloud_measures_component`

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

Measures Component Tree`sonarcloud_measures_component_tree`

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

Measures Search History`sonarcloud_measures_search_history`

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

Metrics Search`sonarcloud_metrics_search`

Search for metrics

Metrics Types`sonarcloud_metrics_types`

List all available metric types.

Notifications Add`sonarcloud_notifications_add`

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

Notifications List`sonarcloud_notifications_list`

List notifications of the authenticated user

Notifications Remove`sonarcloud_notifications_remove`

Remove a notification for the authenticated user

Permissions Add Project Creator To Template`sonarcloud_permissions_add_project_creator_to_template`

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

Permissions Add User`sonarcloud_permissions_add_user`

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

Permissions Add User To Template`sonarcloud_permissions_add_user_to_template`

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

Permissions Apply Template`sonarcloud_permissions_apply_template`

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

Permissions Bulk Apply Template`sonarcloud_permissions_bulk_apply_template`

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

Permissions Create Template`sonarcloud_permissions_create_template`

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

Permissions Delete Template`sonarcloud_permissions_delete_template`

Delete a permission template.Requires the permission 'Administer' on the organization.

Permissions Remove Project Creator From Template`sonarcloud_permissions_remove_project_creator_from_template`

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

Permissions Remove User`sonarcloud_permissions_remove_user`

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

Permissions Remove User From Template`sonarcloud_permissions_remove_user_from_template`

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

Permissions Search Templates`sonarcloud_permissions_search_templates`

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

Permissions Set Default Template`sonarcloud_permissions_set_default_template`

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

Permissions Update Template`sonarcloud_permissions_update_template`

Update a permission template.Requires the permission 'Administer' on the organization.

Project Analyses Create Event`sonarcloud_project_analyses_create_event`

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

Project Analyses Delete`sonarcloud_project_analyses_delete`

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

Project Analyses Delete Event`sonarcloud_project_analyses_delete_event`

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

Project Analyses Search`sonarcloud_project_analyses_search`

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

Project Analyses Unset Baseline`sonarcloud_project_analyses_unset_baseline`

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

Project Analyses Update Event`sonarcloud_project_analyses_update_event`

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

Project Badges Ai Code Assurance`sonarcloud_project_badges_ai_code_assurance`

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

Project Badges Measure`sonarcloud_project_badges_measure`

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

Project Badges Quality Gate`sonarcloud_project_badges_quality_gate`

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

Project Branches Delete`sonarcloud_project_branches_delete`

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

Project Branches List`sonarcloud_project_branches_list`

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

Project Branches Rename`sonarcloud_project_branches_rename`

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

Project Links Create`sonarcloud_project_links_create`

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

Project Links Delete`sonarcloud_project_links_delete`

Delete existing project link.Requires 'Administer' permission on the specified project, or global 'Administer' permissio...

Project Links Search`sonarcloud_project_links_search`

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

Project Pull Requests Delete`sonarcloud_project_pull_requests_delete`

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

Project Pull Requests List`sonarcloud_project_pull_requests_list`

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

Project Tags Search`sonarcloud_project_tags_search`

Search tags

Project Tags Set`sonarcloud_project_tags_set`

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

Projects Bulk Delete`sonarcloud_projects_bulk_delete`

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

Projects Create`sonarcloud_projects_create`

Create a project.Requires 'Create Projects' permission

Projects Delete`sonarcloud_projects_delete`

Delete a project. Requires 'Administer System' permission or 'Administer' permission on the project.

Projects Search`sonarcloud_projects_search`

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

Projects Update Key`sonarcloud_projects_update_key`

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

Projects Update Visibility`sonarcloud_projects_update_visibility`

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

Qualityprofiles Backup`sonarcloud_qualityprofiles_backup`

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

Qualityprofiles Changelog`sonarcloud_qualityprofiles_changelog`

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

Qualityprofiles Copy`sonarcloud_qualityprofiles_copy`

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

Qualityprofiles Create`sonarcloud_qualityprofiles_create`

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

Qualityprofiles Delete`sonarcloud_qualityprofiles_delete`

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

Qualityprofiles Inheritance`sonarcloud_qualityprofiles_inheritance`

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

Qualityprofiles Projects`sonarcloud_qualityprofiles_projects`

List projects with their association status regarding a quality profile

Qualityprofiles Search`sonarcloud_qualityprofiles_search`

Search quality profiles

Rules Repositories`sonarcloud_rules_repositories`

List available rule repositories

Rules Search`sonarcloud_rules_search`

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

Rules Show`sonarcloud_rules_show`

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

Rules Tags`sonarcloud_rules_tags`

List rule tags

Rules Update`sonarcloud_rules_update`

Update an existing rule.Requires the 'Administer Quality Profiles' permission

Settings List Definitions`sonarcloud_settings_list_definitions`

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

Settings Reset`sonarcloud_settings_reset`

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

User Groups Add User`sonarcloud_user_groups_add_user`

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

User Groups Create`sonarcloud_user_groups_create`

Create a group.Requires the following permission: 'Administer System'.

User Groups Delete`sonarcloud_user_groups_delete`

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

User Groups Search`sonarcloud_user_groups_search`

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

User Groups Update`sonarcloud_user_groups_update`

Update a group.Requires the following permission: 'Administer System'.

User Groups Users`sonarcloud_user_groups_users`

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

User Tokens Generate`sonarcloud_user_tokens_generate`

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

User Tokens Revoke`sonarcloud_user_tokens_revoke`

Revoke an access token of the authenticated user.

User Tokens Search`sonarcloud_user_tokens_search`

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

Users Groups`sonarcloud_users_groups`

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

Webhooks List`sonarcloud_webhooks_list`

List the webhooks configured for an organization or a specific project.

Webhooks Create`sonarcloud_webhooks_create`

Create a new webhook for an organization or a specific project.

Webhooks Update`sonarcloud_webhooks_update`

Update the name, URL, or secret of an existing webhook.

Webhooks Delete`sonarcloud_webhooks_delete`

Delete a webhook by its key.

Webhooks Deliveries`sonarcloud_webhooks_deliveries`

List recent webhook deliveries for a webhook, task, or project.

Webhooks Delivery`sonarcloud_webhooks_delivery`

Get a single webhook delivery, including its full payload.

Webservices List`sonarcloud_webservices_list`

List web services

Webservices Response Example`sonarcloud_webservices_response_example`

Display web service response example

## Events

Tags

Select all
|
Clear

Analyses

Health Check

Projects

Quality Gates

Webhooks

No tags found

6 events

EventDescriptionTags

Active Check`sonarcloud_active_check`

Responds with 200 OK to any SonarCloud webhook delivery that cannot be matched to a known event type.

Health Check

Project Analysis Completed`sonarcloud_webhook_project_analysis_completed`

Fired when a project analysis completes successfully but no quality gate verdict is present (gate not configured or not...

ProjectsAnalysesWebhooks

Quality Gate Failed`sonarcloud_webhook_quality_gate_failed`

Fired when a project analysis completes successfully but the quality gate result is ERROR (the code did not pass the gat...

Quality GatesWebhooks

Quality Gate Passed`sonarcloud_webhook_quality_gate_passed`

Fired when a project analysis completes successfully and the quality gate result is OK (the code passed the gate).

Quality GatesWebhooks

Project Analysis Failed`sonarcloud_webhook_project_analysis_failed`

Fired when a project analysis background task fails (status FAILED) — the scan did not complete.

ProjectsAnalysesWebhooks

Project Analysis Canceled`sonarcloud_webhook_project_analysis_canceled`

Fired when a project analysis background task is canceled (status CANCELED) before completion.

ProjectsAnalysesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.