Can I use SonarCloud as a CLI?

Yes. KosmoKrator exposes a SonarCloud CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose SonarCloud through MCP?

Yes. The KosmoKrator MCP gateway can expose selected SonarCloud tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are SonarCloud credentials stored?

SonarCloud credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for SonarCloud MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

SonarCloud Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the SonarCloud KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.sonarcloud.*. Use lua_read_doc("integrations.sonarcloud") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic SonarCloud workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.sonarcloud.authentication_logout({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("sonarcloud"))' --json
kosmo integrations:lua --eval 'print(docs.read("sonarcloud.authentication_logout"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local sonarcloud = app.integrations.sonarcloud
local result = sonarcloud.authentication_logout({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.sonarcloud, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.sonarcloud.default.* or app.integrations.sonarcloud.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need SonarCloud, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

SonarCloud Lua Tools

Namespace: sonarcloud

This integration is generated from the SonarCloud Web API registry exposed by https://sonarcloud.io/api/webservices/list. It uses bearer-token authentication and sends GET parameters as query strings and POST parameters as form data.

Configure api_token with a SonarCloud token and url with the Cloud base URL. The default EU instance is https://sonarcloud.io; SonarSource also documents a US instance at https://sonarqube.us.

Coverage

Services: 33
Tools: 156
Read tools: 69
Write tools: 87

Usage Notes

Tool parameters use snake_case, while requests are sent with official parameter names.
POST tools send form data, not JSON bodies.
Empty optional parameters are omitted.
Cloud and Server have different API surfaces; use sonarcloud for SonarQube Cloud and sonarqube for self-hosted/server instances.

Example Tools

sonarcloud_authentication_logout -> POST /api/authentication/logout
sonarcloud_authentication_validate -> GET /api/authentication/validate
sonarcloud_ce_activity -> GET /api/ce/activity
sonarcloud_ce_activity_status -> GET /api/ce/activity_status
sonarcloud_ce_component -> GET /api/ce/component

Example Lua

local projects = sonarcloud.sonarcloud_projects_search({ organization = "example-org" })
local measures = sonarcloud.sonarcloud_measures_component({ component = "example-key", metric_keys = "bugs,vulnerabilities,code_smells" })

Raw agent markdown

# SonarCloud Lua Tools

Namespace: `sonarcloud`

This integration is generated from the SonarCloud Web API registry exposed by `https://sonarcloud.io/api/webservices/list`. It uses bearer-token authentication and sends GET parameters as query strings and POST parameters as form data.

Configure `api_token` with a SonarCloud token and `url` with the Cloud base URL. The default EU instance is `https://sonarcloud.io`; SonarSource also documents a US instance at `https://sonarqube.us`.

## Coverage

- Services: 33
- Tools: 156
- Read tools: 69
- Write tools: 87

## Usage Notes

- Tool parameters use snake_case, while requests are sent with official parameter names.
- POST tools send form data, not JSON bodies.
- Empty optional parameters are omitted.
- Cloud and Server have different API surfaces; use `sonarcloud` for SonarQube Cloud and `sonarqube` for self-hosted/server instances.

## Example Tools

- `sonarcloud_authentication_logout` -> `POST /api/authentication/logout`
- `sonarcloud_authentication_validate` -> `GET /api/authentication/validate`
- `sonarcloud_ce_activity` -> `GET /api/ce/activity`
- `sonarcloud_ce_activity_status` -> `GET /api/ce/activity_status`
- `sonarcloud_ce_component` -> `GET /api/ce/component`

## Example Lua

```lua
local projects = sonarcloud.sonarcloud_projects_search({ organization = "example-org" })
local measures = sonarcloud.sonarcloud_measures_component({ component = "example-key", metric_keys = "bugs,vulnerabilities,code_smells" })
```

Metadata-derived Lua example

local result = app.integrations.sonarcloud.authentication_logout({})
print(result)

Functions

authentication_logout Write

Logout a user. Official SonarCloud Web API endpoint: POST /api/authentication/logout.

Lua path: app.integrations.sonarcloud.authentication_logout
Full name: sonarcloud.sonarcloud_authentication_logout

Parameter	Type	Required	Description
No parameters.

authentication_validate Read

Check credentials. Returns true for anonymous user. Official SonarCloud Web API endpoint: GET /api/authentication/validate.

Lua path: app.integrations.sonarcloud.authentication_validate
Full name: sonarcloud.sonarcloud_authentication_validate

Parameter	Type	Required	Description
No parameters.

ce_activity Read

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.

Lua path: app.integrations.sonarcloud.ce_activity
Full name: sonarcloud.sonarcloud_ce_activity

Parameter	Type	Required	Description
No parameters.

ce_activity_status Read

Returns CE activity related metrics. Requires 'Administer' permission on the specified project. Official SonarCloud Web API endpoint: GET /api/ce/activity_status.

Lua path: app.integrations.sonarcloud.ce_activity_status
Full name: sonarcloud.sonarcloud_ce_activity_status

Parameter	Type	Required	Description
No parameters.

ce_component Read

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

Lua path: app.integrations.sonarcloud.ce_component
Full name: sonarcloud.sonarcloud_ce_component

Parameter	Type	Required	Description
No parameters.

ce_task Read

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.

Lua path: app.integrations.sonarcloud.ce_task
Full name: sonarcloud.sonarcloud_ce_task

Parameter	Type	Required	Description
No parameters.

components_search Read

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.

Lua path: app.integrations.sonarcloud.components_search
Full name: sonarcloud.sonarcloud_components_search

Parameter	Type	Required	Description
No parameters.

components_show Read

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 /

Lua path: app.integrations.sonarcloud.components_show
Full name: sonarcloud.sonarcloud_components_show

Parameter	Type	Required	Description
No parameters.

components_tree Read

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/

Lua path: app.integrations.sonarcloud.components_tree
Full name: sonarcloud.sonarcloud_components_tree

Parameter	Type	Required	Description
No parameters.

duplications_show Read

Get duplications. Require Browse permission on file's project Official SonarCloud Web API endpoint: GET /api/duplications/show.

Lua path: app.integrations.sonarcloud.duplications_show
Full name: sonarcloud.sonarcloud_duplications_show

Parameter	Type	Required	Description
No parameters.

favorites_add Write

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.

Lua path: app.integrations.sonarcloud.favorites_add
Full name: sonarcloud.sonarcloud_favorites_add

Parameter	Type	Required	Description
No parameters.

favorites_remove Write

Remove a component (project, directory, file etc.) as favorite for the authenticated user. Requires authentication. Official SonarCloud Web API endpoint: POST /api/favorites/remove.

Lua path: app.integrations.sonarcloud.favorites_remove
Full name: sonarcloud.sonarcloud_favorites_remove

Parameter	Type	Required	Description
No parameters.

favorites_search Read

Search for the authenticated user favorites. Requires authentication. Official SonarCloud Web API endpoint: GET /api/favorites/search.

Lua path: app.integrations.sonarcloud.favorites_search
Full name: sonarcloud.sonarcloud_favorites_search

Parameter	Type	Required	Description
No parameters.

favourites_index Read

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.

Lua path: app.integrations.sonarcloud.favourites_index
Full name: sonarcloud.sonarcloud_favourites_index

Parameter	Type	Required	Description
No parameters.

hotspots_change_status Write

Change the status of a Security Hotpot. Requires the 'Administer Security Hotspot' permission. Official SonarCloud Web API endpoint: POST /api/hotspots/change_status.

Lua path: app.integrations.sonarcloud.hotspots_change_status
Full name: sonarcloud.sonarcloud_hotspots_change_status

Parameter	Type	Required	Description
No parameters.

hotspots_search Read

Search for Security Hotpots. Official SonarCloud Web API endpoint: GET /api/hotspots/search.

Lua path: app.integrations.sonarcloud.hotspots_search
Full name: sonarcloud.sonarcloud_hotspots_search

Parameter	Type	Required	Description
No parameters.

hotspots_show Read

Provides the details of a Security Hotspot. Official SonarCloud Web API endpoint: GET /api/hotspots/show.

Lua path: app.integrations.sonarcloud.hotspots_show
Full name: sonarcloud.sonarcloud_hotspots_show

Parameter	Type	Required	Description
No parameters.

issues_add_comment Write

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.

Lua path: app.integrations.sonarcloud.issues_add_comment
Full name: sonarcloud.sonarcloud_issues_add_comment

Parameter	Type	Required	Description
No parameters.

issues_assign Write

Assign/Unassign an issue. Requires authentication and Browse permission on project Official SonarCloud Web API endpoint: POST /api/issues/assign.

Lua path: app.integrations.sonarcloud.issues_assign
Full name: sonarcloud.sonarcloud_issues_assign

Parameter	Type	Required	Description
No parameters.

issues_authors Read

Search SCM accounts which match a given query. Requires authentication. Official SonarCloud Web API endpoint: GET /api/issues/authors.

Lua path: app.integrations.sonarcloud.issues_authors
Full name: sonarcloud.sonarcloud_issues_authors

Parameter	Type	Required	Description
No parameters.

issues_bulk_change Write

Bulk change on issues. Requires authentication. Official SonarCloud Web API endpoint: POST /api/issues/bulk_change.

Lua path: app.integrations.sonarcloud.issues_bulk_change
Full name: sonarcloud.sonarcloud_issues_bulk_change

Parameter	Type	Required	Description
No parameters.

issues_changelog Read

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.

Lua path: app.integrations.sonarcloud.issues_changelog
Full name: sonarcloud.sonarcloud_issues_changelog

Parameter	Type	Required	Description
No parameters.

issues_delete_comment Write

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.

Lua path: app.integrations.sonarcloud.issues_delete_comment
Full name: sonarcloud.sonarcloud_issues_delete_comment

Parameter	Type	Required	Description
No parameters.

issues_do_transition Write

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

Lua path: app.integrations.sonarcloud.issues_do_transition
Full name: sonarcloud.sonarcloud_issues_do_transition

Parameter	Type	Required	Description
No parameters.

issues_edit_comment Write

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.

Lua path: app.integrations.sonarcloud.issues_edit_comment
Full name: sonarcloud.sonarcloud_issues_edit_comment

Parameter	Type	Required	Description
No parameters.

issues_search Read

Search for issues. Requires the 'Browse' permission on the specified project(s). Official SonarCloud Web API endpoint: GET /api/issues/search.

Lua path: app.integrations.sonarcloud.issues_search
Full name: sonarcloud.sonarcloud_issues_search

Parameter	Type	Required	Description
No parameters.

issues_set_severity Write

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.

Lua path: app.integrations.sonarcloud.issues_set_severity
Full name: sonarcloud.sonarcloud_issues_set_severity

Parameter	Type	Required	Description
No parameters.

issues_set_tags Write

Set tags on an issue. Requires authentication and Browse permission on project Official SonarCloud Web API endpoint: POST /api/issues/set_tags.

Lua path: app.integrations.sonarcloud.issues_set_tags
Full name: sonarcloud.sonarcloud_issues_set_tags

Parameter	Type	Required	Description
No parameters.

issues_set_type Write

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

Lua path: app.integrations.sonarcloud.issues_set_type
Full name: sonarcloud.sonarcloud_issues_set_type

Parameter	Type	Required	Description
No parameters.

issues_tags Read

List tags matching a given query Official SonarCloud Web API endpoint: GET /api/issues/tags.

Lua path: app.integrations.sonarcloud.issues_tags
Full name: sonarcloud.sonarcloud_issues_tags

Parameter	Type	Required	Description
No parameters.

languages_list Read

List supported programming languages Official SonarCloud Web API endpoint: GET /api/languages/list.

Lua path: app.integrations.sonarcloud.languages_list
Full name: sonarcloud.sonarcloud_languages_list

Parameter	Type	Required	Description
No parameters.

measures_component Read

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.

Lua path: app.integrations.sonarcloud.measures_component
Full name: sonarcloud.sonarcloud_measures_component

Parameter	Type	Required	Description
No parameters.

measures_component_tree Read

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,

Lua path: app.integrations.sonarcloud.measures_component_tree
Full name: sonarcloud.sonarcloud_measures_component_tree

Parameter	Type	Required	Description
No parameters.

measures_search_history Read

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

Lua path: app.integrations.sonarcloud.measures_search_history
Full name: sonarcloud.sonarcloud_measures_search_history

Parameter	Type	Required	Description
No parameters.

metrics_domains Read

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.

Lua path: app.integrations.sonarcloud.metrics_domains
Full name: sonarcloud.sonarcloud_metrics_domains

Parameter	Type	Required	Description
No parameters.

metrics_search Read

Search for metrics Official SonarCloud Web API endpoint: GET /api/metrics/search.

Lua path: app.integrations.sonarcloud.metrics_search
Full name: sonarcloud.sonarcloud_metrics_search

Parameter	Type	Required	Description
No parameters.

metrics_types Read

List all available metric types. Official SonarCloud Web API endpoint: GET /api/metrics/types.

Lua path: app.integrations.sonarcloud.metrics_types
Full name: sonarcloud.sonarcloud_metrics_types

Parameter	Type	Required	Description
No parameters.

notifications_add Write

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 '

Lua path: app.integrations.sonarcloud.notifications_add
Full name: sonarcloud.sonarcloud_notifications_add

Parameter	Type	Required	Description
No parameters.

notifications_list Read

List notifications of the authenticated user Official SonarCloud Web API endpoint: GET /api/notifications/list.

Lua path: app.integrations.sonarcloud.notifications_list
Full name: sonarcloud.sonarcloud_notifications_list

Parameter	Type	Required	Description
No parameters.

notifications_remove Write

Remove a notification for the authenticated user Official SonarCloud Web API endpoint: POST /api/notifications/remove.

Lua path: app.integrations.sonarcloud.notifications_remove
Full name: sonarcloud.sonarcloud_notifications_remove

Parameter	Type	Required	Description
No parameters.

permissions_add_group Write

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

Lua path: app.integrations.sonarcloud.permissions_add_group
Full name: sonarcloud.sonarcloud_permissions_add_group

Parameter	Type	Required	Description
No parameters.

permissions_add_group_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_add_group_template
Full name: sonarcloud.sonarcloud_permissions_add_group_to_template

Parameter	Type	Required	Description
No parameters.

permissions_add_project_creator_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_add_project_creator_template
Full name: sonarcloud.sonarcloud_permissions_add_project_creator_to_template

Parameter	Type	Required	Description
No parameters.

permissions_add_user Write

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

Lua path: app.integrations.sonarcloud.permissions_add_user
Full name: sonarcloud.sonarcloud_permissions_add_user

Parameter	Type	Required	Description
No parameters.

permissions_add_user_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_add_user_template
Full name: sonarcloud.sonarcloud_permissions_add_user_to_template

Parameter	Type	Required	Description
No parameters.

permissions_apply_template Write

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

Lua path: app.integrations.sonarcloud.permissions_apply_template
Full name: sonarcloud.sonarcloud_permissions_apply_template

Parameter	Type	Required	Description
No parameters.

permissions_bulk_apply_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_bulk_apply_template
Full name: sonarcloud.sonarcloud_permissions_bulk_apply_template

Parameter	Type	Required	Description
No parameters.

permissions_create_template Write

Create a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/create_template.

Lua path: app.integrations.sonarcloud.permissions_create_template
Full name: sonarcloud.sonarcloud_permissions_create_template

Parameter	Type	Required	Description
No parameters.

permissions_delete_template Write

Delete a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/delete_template.

Lua path: app.integrations.sonarcloud.permissions_delete_template
Full name: sonarcloud.sonarcloud_permissions_delete_template

Parameter	Type	Required	Description
No parameters.

permissions_remove_group Write

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

Lua path: app.integrations.sonarcloud.permissions_remove_group
Full name: sonarcloud.sonarcloud_permissions_remove_group

Parameter	Type	Required	Description
No parameters.

permissions_remove_group_from_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_remove_group_from_template
Full name: sonarcloud.sonarcloud_permissions_remove_group_from_template

Parameter	Type	Required	Description
No parameters.

permissions_remove_project_creator_from_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_remove_project_creator_from_template
Full name: sonarcloud.sonarcloud_permissions_remove_project_creator_from_template

Parameter	Type	Required	Description
No parameters.

permissions_remove_user Write

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:

Lua path: app.integrations.sonarcloud.permissions_remove_user
Full name: sonarcloud.sonarcloud_permissions_remove_user

Parameter	Type	Required	Description
No parameters.

permissions_remove_user_from_template Write

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.

Lua path: app.integrations.sonarcloud.permissions_remove_user_from_template
Full name: sonarcloud.sonarcloud_permissions_remove_user_from_template

Parameter	Type	Required	Description
No parameters.

permissions_search_templates Read

List permission templates. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: GET /api/permissions/search_templates.

Lua path: app.integrations.sonarcloud.permissions_search_templates
Full name: sonarcloud.sonarcloud_permissions_search_templates

Parameter	Type	Required	Description
No parameters.

permissions_set_default_template Write

Set a permission template as default. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/set_default_template.

Lua path: app.integrations.sonarcloud.permissions_set_default_template
Full name: sonarcloud.sonarcloud_permissions_set_default_template

Parameter	Type	Required	Description
No parameters.

permissions_update_template Write

Update a permission template. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: POST /api/permissions/update_template.

Lua path: app.integrations.sonarcloud.permissions_update_template
Full name: sonarcloud.sonarcloud_permissions_update_template

Parameter	Type	Required	Description
No parameters.

project_analyses_create_event Write

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.

Lua path: app.integrations.sonarcloud.project_analyses_create_event
Full name: sonarcloud.sonarcloud_project_analyses_create_event

Parameter	Type	Required	Description
No parameters.

project_analyses_delete Write

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.

Lua path: app.integrations.sonarcloud.project_analyses_delete
Full name: sonarcloud.sonarcloud_project_analyses_delete

Parameter	Type	Required	Description
No parameters.

project_analyses_delete_event Write

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.

Lua path: app.integrations.sonarcloud.project_analyses_delete_event
Full name: sonarcloud.sonarcloud_project_analyses_delete_event

Parameter	Type	Required	Description
No parameters.

project_analyses_search Read

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.

Lua path: app.integrations.sonarcloud.project_analyses_search
Full name: sonarcloud.sonarcloud_project_analyses_search

Parameter	Type	Required	Description
No parameters.

project_analyses_set_baseline Write

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

Lua path: app.integrations.sonarcloud.project_analyses_set_baseline
Full name: sonarcloud.sonarcloud_project_analyses_set_baseline

Parameter	Type	Required	Description
No parameters.

project_analyses_unset_baseline Write

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

Lua path: app.integrations.sonarcloud.project_analyses_unset_baseline
Full name: sonarcloud.sonarcloud_project_analyses_unset_baseline

Parameter	Type	Required	Description
No parameters.

project_analyses_update_event Write

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.

Lua path: app.integrations.sonarcloud.project_analyses_update_event
Full name: sonarcloud.sonarcloud_project_analyses_update_event

Parameter	Type	Required	Description
No parameters.

project_badges_ai_code_assurance Read

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.

Lua path: app.integrations.sonarcloud.project_badges_ai_code_assurance
Full name: sonarcloud.sonarcloud_project_badges_ai_code_assurance

Parameter	Type	Required	Description
No parameters.

project_badges_measure Read

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.

Lua path: app.integrations.sonarcloud.project_badges_measure
Full name: sonarcloud.sonarcloud_project_badges_measure

Parameter	Type	Required	Description
No parameters.

project_badges_quality_gate Read

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.

Lua path: app.integrations.sonarcloud.project_badges_quality_gate
Full name: sonarcloud.sonarcloud_project_badges_quality_gate

Parameter	Type	Required	Description
No parameters.

project_branches_delete Write

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.

Lua path: app.integrations.sonarcloud.project_branches_delete
Full name: sonarcloud.sonarcloud_project_branches_delete

Parameter	Type	Required	Description
No parameters.

project_branches_list Read

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,

Lua path: app.integrations.sonarcloud.project_branches_list
Full name: sonarcloud.sonarcloud_project_branches_list

Parameter	Type	Required	Description
No parameters.

project_branches_rename Write

Rename the main branch of a project. Requires 'Administer' permission on the specified project. Official SonarCloud Web API endpoint: POST /api/project_branches/rename.

Lua path: app.integrations.sonarcloud.project_branches_rename
Full name: sonarcloud.sonarcloud_project_branches_rename

Parameter	Type	Required	Description
No parameters.

project_links_create Write

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.

Lua path: app.integrations.sonarcloud.project_links_create
Full name: sonarcloud.sonarcloud_project_links_create

Parameter	Type	Required	Description
No parameters.

project_links_delete Write

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.

Lua path: app.integrations.sonarcloud.project_links_delete
Full name: sonarcloud.sonarcloud_project_links_delete

Parameter	Type	Required	Description
No parameters.

project_links_search Read

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

Lua path: app.integrations.sonarcloud.project_links_search
Full name: sonarcloud.sonarcloud_project_links_search

Parameter	Type	Required	Description
No parameters.

project_pull_requests_delete Write

Delete a pull request. Requires 'Administer' rights on the specified project. Official SonarCloud Web API endpoint: POST /api/project_pull_requests/delete.

Lua path: app.integrations.sonarcloud.project_pull_requests_delete
Full name: sonarcloud.sonarcloud_project_pull_requests_delete

Parameter	Type	Required	Description
No parameters.

project_pull_requests_list Read

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.

Lua path: app.integrations.sonarcloud.project_pull_requests_list
Full name: sonarcloud.sonarcloud_project_pull_requests_list

Parameter	Type	Required	Description
No parameters.

project_tags_search Read

Search tags Official SonarCloud Web API endpoint: GET /api/project_tags/search.

Lua path: app.integrations.sonarcloud.project_tags_search
Full name: sonarcloud.sonarcloud_project_tags_search

Parameter	Type	Required	Description
No parameters.

project_tags_set Write

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.

Lua path: app.integrations.sonarcloud.project_tags_set
Full name: sonarcloud.sonarcloud_project_tags_set

Parameter	Type	Required	Description
No parameters.

projects_bulk_delete Write

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 /

Lua path: app.integrations.sonarcloud.projects_bulk_delete
Full name: sonarcloud.sonarcloud_projects_bulk_delete

Parameter	Type	Required	Description
No parameters.

projects_bulk_update_key Write

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

Lua path: app.integrations.sonarcloud.projects_bulk_update_key
Full name: sonarcloud.sonarcloud_projects_bulk_update_key

Parameter	Type	Required	Description
No parameters.

projects_create Write

Create a project. Requires 'Create Projects' permission Official SonarCloud Web API endpoint: POST /api/projects/create.

Lua path: app.integrations.sonarcloud.projects_create
Full name: sonarcloud.sonarcloud_projects_create

Parameter	Type	Required	Description
No parameters.

projects_delete Write

Delete a project. Requires 'Administer System' permission or 'Administer' permission on the project. Official SonarCloud Web API endpoint: POST /api/projects/delete.

Lua path: app.integrations.sonarcloud.projects_delete
Full name: sonarcloud.sonarcloud_projects_delete

Parameter	Type	Required	Description
No parameters.

projects_search Read

Search for projects to administrate them. Requires 'System Administrator' permission Official SonarCloud Web API endpoint: GET /api/projects/search.

Lua path: app.integrations.sonarcloud.projects_search
Full name: sonarcloud.sonarcloud_projects_search

Parameter	Type	Required	Description
No parameters.

projects_update_key Write

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.

Lua path: app.integrations.sonarcloud.projects_update_key
Full name: sonarcloud.sonarcloud_projects_update_key

Parameter	Type	Required	Description
No parameters.

projects_update_visibility Write

Updates visibility of a project. Requires 'Project administer' permission on the specified project Official SonarCloud Web API endpoint: POST /api/projects/update_visibility.

Lua path: app.integrations.sonarcloud.projects_update_visibility
Full name: sonarcloud.sonarcloud_projects_update_visibility

Parameter	Type	Required	Description
No parameters.

properties_index Read

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.

Lua path: app.integrations.sonarcloud.properties_index
Full name: sonarcloud.sonarcloud_properties_index

Parameter	Type	Required	Description
No parameters.

qualitygates_copy Write

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.

Lua path: app.integrations.sonarcloud.qualitygates_copy
Full name: sonarcloud.sonarcloud_qualitygates_copy

Parameter	Type	Required	Description
No parameters.

qualitygates_create Write

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.

Lua path: app.integrations.sonarcloud.qualitygates_create
Full name: sonarcloud.sonarcloud_qualitygates_create

Parameter	Type	Required	Description
No parameters.

qualitygates_create_condition Write

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

Lua path: app.integrations.sonarcloud.qualitygates_create_condition
Full name: sonarcloud.sonarcloud_qualitygates_create_condition

Parameter	Type	Required	Description
No parameters.

qualitygates_delete_condition Write

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

Lua path: app.integrations.sonarcloud.qualitygates_delete_condition
Full name: sonarcloud.sonarcloud_qualitygates_delete_condition

Parameter	Type	Required	Description
No parameters.

qualitygates_deselect Write

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

Lua path: app.integrations.sonarcloud.qualitygates_deselect
Full name: sonarcloud.sonarcloud_qualitygates_deselect

Parameter	Type	Required	Description
No parameters.

qualitygates_destroy Write

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.

Lua path: app.integrations.sonarcloud.qualitygates_destroy
Full name: sonarcloud.sonarcloud_qualitygates_destroy

Parameter	Type	Required	Description
No parameters.

qualitygates_get_by_project Read

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

Lua path: app.integrations.sonarcloud.qualitygates_get_by_project
Full name: sonarcloud.sonarcloud_qualitygates_get_by_project

Parameter	Type	Required	Description
No parameters.

qualitygates_list Read

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.

Lua path: app.integrations.sonarcloud.qualitygates_list
Full name: sonarcloud.sonarcloud_qualitygates_list

Parameter	Type	Required	Description
No parameters.

qualitygates_project_status Read

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

Lua path: app.integrations.sonarcloud.qualitygates_project_status
Full name: sonarcloud.sonarcloud_qualitygates_project_status

Parameter	Type	Required	Description
No parameters.

qualitygates_rename Write

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.

Lua path: app.integrations.sonarcloud.qualitygates_rename
Full name: sonarcloud.sonarcloud_qualitygates_rename

Parameter	Type	Required	Description
No parameters.

qualitygates_search Read

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

Lua path: app.integrations.sonarcloud.qualitygates_search
Full name: sonarcloud.sonarcloud_qualitygates_search

Parameter	Type	Required	Description
No parameters.

qualitygates_select Write

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

Lua path: app.integrations.sonarcloud.qualitygates_select
Full name: sonarcloud.sonarcloud_qualitygates_select

Parameter	Type	Required	Description
No parameters.

qualitygates_set_default Write

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

Lua path: app.integrations.sonarcloud.qualitygates_set_default
Full name: sonarcloud.sonarcloud_qualitygates_set_as_default

Parameter	Type	Required	Description
No parameters.

qualitygates_show Read

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.

Lua path: app.integrations.sonarcloud.qualitygates_show
Full name: sonarcloud.sonarcloud_qualitygates_show

Parameter	Type	Required	Description
No parameters.

qualitygates_unset_default Write

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.

Lua path: app.integrations.sonarcloud.qualitygates_unset_default
Full name: sonarcloud.sonarcloud_qualitygates_unset_default

Parameter	Type	Required	Description
No parameters.

qualitygates_update_condition Write

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

Lua path: app.integrations.sonarcloud.qualitygates_update_condition
Full name: sonarcloud.sonarcloud_qualitygates_update_condition

Parameter	Type	Required	Description
No parameters.

qualityprofiles_activate_rule Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_activate_rule
Full name: sonarcloud.sonarcloud_qualityprofiles_activate_rule

Parameter	Type	Required	Description
No parameters.

qualityprofiles_activate_rules Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_activate_rules
Full name: sonarcloud.sonarcloud_qualityprofiles_activate_rules

Parameter	Type	Required	Description
No parameters.

qualityprofiles_add_project Write

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

Lua path: app.integrations.sonarcloud.qualityprofiles_add_project
Full name: sonarcloud.sonarcloud_qualityprofiles_add_project

Parameter	Type	Required	Description
No parameters.

qualityprofiles_backup Read

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_backup
Full name: sonarcloud.sonarcloud_qualityprofiles_backup

Parameter	Type	Required	Description
No parameters.

qualityprofiles_change_parent Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_change_parent
Full name: sonarcloud.sonarcloud_qualityprofiles_change_parent

Parameter	Type	Required	Description
No parameters.

qualityprofiles_changelog Read

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_changelog
Full name: sonarcloud.sonarcloud_qualityprofiles_changelog

Parameter	Type	Required	Description
No parameters.

qualityprofiles_copy Write

Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarCloud Web API endpoint: POST /api/qualityprofiles/copy.

Lua path: app.integrations.sonarcloud.qualityprofiles_copy
Full name: sonarcloud.sonarcloud_qualityprofiles_copy

Parameter	Type	Required	Description
No parameters.

qualityprofiles_create Write

Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. Official SonarCloud Web API endpoint: POST /api/qualityprofiles/create.

Lua path: app.integrations.sonarcloud.qualityprofiles_create
Full name: sonarcloud.sonarcloud_qualityprofiles_create

Parameter	Type	Required	Description
No parameters.

qualityprofiles_deactivate_rule Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_deactivate_rule
Full name: sonarcloud.sonarcloud_qualityprofiles_deactivate_rule

Parameter	Type	Required	Description
No parameters.

qualityprofiles_deactivate_rules Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_deactivate_rules
Full name: sonarcloud.sonarcloud_qualityprofiles_deactivate_rules

Parameter	Type	Required	Description
No parameters.

qualityprofiles_delete Write

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

Lua path: app.integrations.sonarcloud.qualityprofiles_delete
Full name: sonarcloud.sonarcloud_qualityprofiles_delete

Parameter	Type	Required	Description
No parameters.

qualityprofiles_export Read

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_export
Full name: sonarcloud.sonarcloud_qualityprofiles_export

Parameter	Type	Required	Description
No parameters.

qualityprofiles_exporters Read

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_exporters
Full name: sonarcloud.sonarcloud_qualityprofiles_exporters

Parameter	Type	Required	Description
No parameters.

qualityprofiles_importers Read

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_importers
Full name: sonarcloud.sonarcloud_qualityprofiles_importers

Parameter	Type	Required	Description
No parameters.

qualityprofiles_inheritance Read

Show a quality profile's ancestors and children. Official SonarCloud Web API endpoint: GET /api/qualityprofiles/inheritance.

Lua path: app.integrations.sonarcloud.qualityprofiles_inheritance
Full name: sonarcloud.sonarcloud_qualityprofiles_inheritance

Parameter	Type	Required	Description
No parameters.

qualityprofiles_projects Read

List projects with their association status regarding a quality profile Official SonarCloud Web API endpoint: GET /api/qualityprofiles/projects.

Lua path: app.integrations.sonarcloud.qualityprofiles_projects
Full name: sonarcloud.sonarcloud_qualityprofiles_projects

Parameter	Type	Required	Description
No parameters.

qualityprofiles_remove_project Write

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

Lua path: app.integrations.sonarcloud.qualityprofiles_remove_project
Full name: sonarcloud.sonarcloud_qualityprofiles_remove_project

Parameter	Type	Required	Description
No parameters.

qualityprofiles_rename Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_rename
Full name: sonarcloud.sonarcloud_qualityprofiles_rename

Parameter	Type	Required	Description
No parameters.

qualityprofiles_restore Write

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

Lua path: app.integrations.sonarcloud.qualityprofiles_restore
Full name: sonarcloud.sonarcloud_qualityprofiles_restore

Parameter	Type	Required	Description
No parameters.

qualityprofiles_restore_built Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_restore_built
Full name: sonarcloud.sonarcloud_qualityprofiles_restore_built_in

Parameter	Type	Required	Description
No parameters.

qualityprofiles_search Read

Search quality profiles Official SonarCloud Web API endpoint: GET /api/qualityprofiles/search.

Lua path: app.integrations.sonarcloud.qualityprofiles_search
Full name: sonarcloud.sonarcloud_qualityprofiles_search

Parameter	Type	Required	Description
No parameters.

qualityprofiles_set_default Write

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.

Lua path: app.integrations.sonarcloud.qualityprofiles_set_default
Full name: sonarcloud.sonarcloud_qualityprofiles_set_default

Parameter	Type	Required	Description
No parameters.

rules_repositories Read

List available rule repositories Official SonarCloud Web API endpoint: GET /api/rules/repositories.

Lua path: app.integrations.sonarcloud.rules_repositories
Full name: sonarcloud.sonarcloud_rules_repositories

Parameter	Type	Required	Description
No parameters.

rules_search Read

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

Lua path: app.integrations.sonarcloud.rules_search
Full name: sonarcloud.sonarcloud_rules_search

Parameter	Type	Required	Description
No parameters.

rules_show Read

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

Lua path: app.integrations.sonarcloud.rules_show
Full name: sonarcloud.sonarcloud_rules_show

Parameter	Type	Required	Description
No parameters.

rules_tags Read

List rule tags Official SonarCloud Web API endpoint: GET /api/rules/tags.

Lua path: app.integrations.sonarcloud.rules_tags
Full name: sonarcloud.sonarcloud_rules_tags

Parameter	Type	Required	Description
No parameters.

rules_update Write

Update an existing rule. Requires the 'Administer Quality Profiles' permission Official SonarCloud Web API endpoint: POST /api/rules/update.

Lua path: app.integrations.sonarcloud.rules_update
Full name: sonarcloud.sonarcloud_rules_update

Parameter	Type	Required	Description
No parameters.

settings_list_definitions Read

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

Lua path: app.integrations.sonarcloud.settings_list_definitions
Full name: sonarcloud.sonarcloud_settings_list_definitions

Parameter	Type	Required	Description
No parameters.

settings_reset Write

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.

Lua path: app.integrations.sonarcloud.settings_reset
Full name: sonarcloud.sonarcloud_settings_reset

Parameter	Type	Required	Description
No parameters.

settings_set Write

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

Lua path: app.integrations.sonarcloud.settings_set
Full name: sonarcloud.sonarcloud_settings_set

Parameter	Type	Required	Description
No parameters.

settings_values Read

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

Lua path: app.integrations.sonarcloud.settings_values
Full name: sonarcloud.sonarcloud_settings_values

Parameter	Type	Required	Description
No parameters.

sources_raw Read

Get source code as raw text. Require 'See Source Code' permission on file Official SonarCloud Web API endpoint: GET /api/sources/raw.

Lua path: app.integrations.sonarcloud.sources_raw
Full name: sonarcloud.sonarcloud_sources_raw

Parameter	Type	Required	Description
No parameters.

sources_scm Read

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

Lua path: app.integrations.sonarcloud.sources_scm
Full name: sonarcloud.sonarcloud_sources_scm

Parameter	Type	Required	Description
No parameters.

sources_show Read

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

Lua path: app.integrations.sonarcloud.sources_show
Full name: sonarcloud.sonarcloud_sources_show

Parameter	Type	Required	Description
No parameters.

timemachine_index Read

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.

Lua path: app.integrations.sonarcloud.timemachine_index
Full name: sonarcloud.sonarcloud_timemachine_index

Parameter	Type	Required	Description
No parameters.

user_groups_add_user Write

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.

Lua path: app.integrations.sonarcloud.user_groups_add_user
Full name: sonarcloud.sonarcloud_user_groups_add_user

Parameter	Type	Required	Description
No parameters.

user_groups_create Write

Create a group. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/create.

Lua path: app.integrations.sonarcloud.user_groups_create
Full name: sonarcloud.sonarcloud_user_groups_create

Parameter	Type	Required	Description
No parameters.

user_groups_delete Write

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.

Lua path: app.integrations.sonarcloud.user_groups_delete
Full name: sonarcloud.sonarcloud_user_groups_delete

Parameter	Type	Required	Description
No parameters.

user_groups_remove_user Write

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.

Lua path: app.integrations.sonarcloud.user_groups_remove_user
Full name: sonarcloud.sonarcloud_user_groups_remove_user

Parameter	Type	Required	Description
No parameters.

user_groups_search Read

Search for user groups. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: GET /api/user_groups/search.

Lua path: app.integrations.sonarcloud.user_groups_search
Full name: sonarcloud.sonarcloud_user_groups_search

Parameter	Type	Required	Description
No parameters.

user_groups_update Write

Update a group. Requires the following permission: 'Administer System'. Official SonarCloud Web API endpoint: POST /api/user_groups/update.

Lua path: app.integrations.sonarcloud.user_groups_update
Full name: sonarcloud.sonarcloud_user_groups_update

Parameter	Type	Required	Description
No parameters.

user_groups_users Read

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.

Lua path: app.integrations.sonarcloud.user_groups_users
Full name: sonarcloud.sonarcloud_user_groups_users

Parameter	Type	Required	Description
No parameters.

user_properties_index Read

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.

Lua path: app.integrations.sonarcloud.user_properties_index
Full name: sonarcloud.sonarcloud_user_properties_index

Parameter	Type	Required	Description
No parameters.

user_tokens_generate Write

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.

Lua path: app.integrations.sonarcloud.user_tokens_generate
Full name: sonarcloud.sonarcloud_user_tokens_generate

Parameter	Type	Required	Description
No parameters.

user_tokens_revoke Write

Revoke an access token of the authenticated user. Official SonarCloud Web API endpoint: POST /api/user_tokens/revoke.

Lua path: app.integrations.sonarcloud.user_tokens_revoke
Full name: sonarcloud.sonarcloud_user_tokens_revoke

Parameter	Type	Required	Description
No parameters.

user_tokens_search Read

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

Lua path: app.integrations.sonarcloud.user_tokens_search
Full name: sonarcloud.sonarcloud_user_tokens_search

Parameter	Type	Required	Description
No parameters.

users_groups Read

Lists the groups a user belongs to. Requires the permission 'Administer' on the organization. Official SonarCloud Web API endpoint: GET /api/users/groups.

Lua path: app.integrations.sonarcloud.users_groups
Full name: sonarcloud.sonarcloud_users_groups

Parameter	Type	Required	Description
No parameters.

webhooks_create Write

Create a Webhook. Requires 'Administer' permission on the specified project. Official SonarCloud Web API endpoint: POST /api/webhooks/create.

Lua path: app.integrations.sonarcloud.webhooks_create
Full name: sonarcloud.sonarcloud_webhooks_create

Parameter	Type	Required	Description
No parameters.

webhooks_delete Write

Delete a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarCloud Web API endpoint: POST /api/webhooks/delete.

Lua path: app.integrations.sonarcloud.webhooks_delete
Full name: sonarcloud.sonarcloud_webhooks_delete

Parameter	Type	Required	Description
No parameters.

webhooks_deliveries Read

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

Lua path: app.integrations.sonarcloud.webhooks_deliveries
Full name: sonarcloud.sonarcloud_webhooks_deliveries

Parameter	Type	Required	Description
No parameters.

webhooks_delivery Read

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.

Lua path: app.integrations.sonarcloud.webhooks_delivery
Full name: sonarcloud.sonarcloud_webhooks_delivery

Parameter	Type	Required	Description
No parameters.

webhooks_list Read

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.

Lua path: app.integrations.sonarcloud.webhooks_list
Full name: sonarcloud.sonarcloud_webhooks_list

Parameter	Type	Required	Description
No parameters.

webhooks_update Write

Update a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarCloud Web API endpoint: POST /api/webhooks/update.

Lua path: app.integrations.sonarcloud.webhooks_update
Full name: sonarcloud.sonarcloud_webhooks_update

Parameter	Type	Required	Description
No parameters.

webservices_list Read

List web services Official SonarCloud Web API endpoint: GET /api/webservices/list.

Lua path: app.integrations.sonarcloud.webservices_list
Full name: sonarcloud.sonarcloud_webservices_list

Parameter	Type	Required	Description
No parameters.

webservices_response_example Read

Display web service response example Official SonarCloud Web API endpoint: GET /api/webservices/response_example.

Lua path: app.integrations.sonarcloud.webservices_response_example
Full name: sonarcloud.sonarcloud_webservices_response_example

Parameter	Type	Required	Description
No parameters.