data
SonarQube Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the SonarQube KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.sonarqube.*.
Use lua_read_doc("integrations.sonarqube") 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
SonarQube workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.sonarqube.alm_integrations_import_azure_project({}))' --json kosmo integrations:lua --eval 'print(docs.read("sonarqube"))' --json
kosmo integrations:lua --eval 'print(docs.read("sonarqube.alm_integrations_import_azure_project"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local sonarqube = app.integrations.sonarqube
local result = sonarqube.alm_integrations_import_azure_project({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.sonarqube, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.sonarqube.default.* or app.integrations.sonarqube.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need SonarQube, use the narrower 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.
SonarQube Lua Tools
Namespace: sonarqube
This integration is generated from the SonarQube Server Web API registry exposed by https://next.sonarqube.com/sonarqube/api/webservices/list. It uses the documented bearer-token authentication scheme and sends GET parameters as query strings and POST parameters as form data, matching SonarQube Web API guidance.
Configure api_token with a SonarQube user token and url with the server base URL, for example https://sonarqube.example.test.
Coverage
- Services: 42
- Tools: 271
- Read tools: 106
- Write tools: 165
Deprecated Web API actions remain exposed when the official registry still lists them, so agents can operate against older servers that have not moved to replacement API v2 endpoints.
Usage Notes
- Tool parameters use snake_case, while requests are sent with the official SonarQube parameter names.
- POST tools send form data, not JSON bodies.
- Empty optional parameters are omitted.
- Returned payloads are parsed JSON when possible; empty responses return
{ success = true, status = <http_status> }.
Example Tools
sonarqube_alm_integrations_list_azure_projects->GET /api/alm_integrations/list_azure_projectssonarqube_alm_integrations_list_bitbucketserver_projects->GET /api/alm_integrations/list_bitbucketserver_projectssonarqube_alm_integrations_search_azure_repos->GET /api/alm_integrations/search_azure_repossonarqube_alm_integrations_search_bitbucketcloud_repos->GET /api/alm_integrations/search_bitbucketcloud_repossonarqube_alm_integrations_search_bitbucketserver_repos->GET /api/alm_integrations/search_bitbucketserver_repossonarqube_alm_integrations_import_azure_project->POST /api/alm_integrations/import_azure_projectsonarqube_alm_integrations_import_bitbucketcloud_repo->POST /api/alm_integrations/import_bitbucketcloud_reposonarqube_alm_integrations_import_bitbucketserver_project->POST /api/alm_integrations/import_bitbucketserver_projectsonarqube_alm_integrations_import_github_project->POST /api/alm_integrations/import_github_projectsonarqube_alm_integrations_import_gitlab_project->POST /api/alm_integrations/import_gitlab_project
Example Lua
local projects = sonarqube.sonarqube_projects_search({ q = "example" })
local measures = sonarqube.sonarqube_measures_component({ component = "example-key", metric_keys = "bugs,vulnerabilities,code_smells" })Raw agent markdown
# SonarQube Lua Tools
Namespace: `sonarqube`
This integration is generated from the SonarQube Server Web API registry exposed by `https://next.sonarqube.com/sonarqube/api/webservices/list`. It uses the documented bearer-token authentication scheme and sends GET parameters as query strings and POST parameters as form data, matching SonarQube Web API guidance.
Configure `api_token` with a SonarQube user token and `url` with the server base URL, for example `https://sonarqube.example.test`.
## Coverage
- Services: 42
- Tools: 271
- Read tools: 106
- Write tools: 165
Deprecated Web API actions remain exposed when the official registry still lists them, so agents can operate against older servers that have not moved to replacement API v2 endpoints.
## Usage Notes
- Tool parameters use snake_case, while requests are sent with the official SonarQube parameter names.
- POST tools send form data, not JSON bodies.
- Empty optional parameters are omitted.
- Returned payloads are parsed JSON when possible; empty responses return `{ success = true, status = <http_status> }`.
## Example Tools
- `sonarqube_alm_integrations_list_azure_projects` -> `GET /api/alm_integrations/list_azure_projects`
- `sonarqube_alm_integrations_list_bitbucketserver_projects` -> `GET /api/alm_integrations/list_bitbucketserver_projects`
- `sonarqube_alm_integrations_search_azure_repos` -> `GET /api/alm_integrations/search_azure_repos`
- `sonarqube_alm_integrations_search_bitbucketcloud_repos` -> `GET /api/alm_integrations/search_bitbucketcloud_repos`
- `sonarqube_alm_integrations_search_bitbucketserver_repos` -> `GET /api/alm_integrations/search_bitbucketserver_repos`
- `sonarqube_alm_integrations_import_azure_project` -> `POST /api/alm_integrations/import_azure_project`
- `sonarqube_alm_integrations_import_bitbucketcloud_repo` -> `POST /api/alm_integrations/import_bitbucketcloud_repo`
- `sonarqube_alm_integrations_import_bitbucketserver_project` -> `POST /api/alm_integrations/import_bitbucketserver_project`
- `sonarqube_alm_integrations_import_github_project` -> `POST /api/alm_integrations/import_github_project`
- `sonarqube_alm_integrations_import_gitlab_project` -> `POST /api/alm_integrations/import_gitlab_project`
## Example Lua
```lua
local projects = sonarqube.sonarqube_projects_search({ q = "example" })
local measures = sonarqube.sonarqube_measures_component({ component = "example-key", metric_keys = "bugs,vulnerabilities,code_smells" })
``` local result = app.integrations.sonarqube.alm_integrations_import_azure_project({})
print(result) Functions
alm_integrations_import_azure_project Write
Create a SonarQube project with the information from the provided Azure DevOps project. Autoconfigure pull request decoration mechanism. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_azure_pro
- Lua path
app.integrations.sonarqube.alm_integrations_import_azure_project- Full name
sonarqube.sonarqube_alm_integrations_import_azure_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_import_bitbucketcloud_repo Write
Create a SonarQube project with the information from the provided Bitbucket Cloud repository. Autoconfigure pull request decoration mechanism. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_bit
- Lua path
app.integrations.sonarqube.alm_integrations_import_bitbucketcloud_repo- Full name
sonarqube.sonarqube_alm_integrations_import_bitbucketcloud_repo
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_import_bitbucketserver_project Write
Create a SonarQube project with the information from the provided BitbucketServer project. Autoconfigure pull request decoration mechanism. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_bitbuc
- Lua path
app.integrations.sonarqube.alm_integrations_import_bitbucketserver_project- Full name
sonarqube.sonarqube_alm_integrations_import_bitbucketserver_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_import_github_project Write
Create a SonarQube project with the information from the provided GitHub repository. Autoconfigure pull request decoration mechanism. If Automatic Provisioning is enable for GitHub, it will also synchronize permissions from the repository. Requires the 'Create
- Lua path
app.integrations.sonarqube.alm_integrations_import_github_project- Full name
sonarqube.sonarqube_alm_integrations_import_github_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_import_gitlab_project Write
Import a GitLab project to SonarQube, creating a new project and configuring MR decoration Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/import_gitlab_project. Deprecated since SonarQube 10.5; kept
- Lua path
app.integrations.sonarqube.alm_integrations_import_gitlab_project- Full name
sonarqube.sonarqube_alm_integrations_import_gitlab_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_list_azure_projects Read
List Azure projects Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/list_azure_projects.
- Lua path
app.integrations.sonarqube.alm_integrations_list_azure_projects- Full name
sonarqube.sonarqube_alm_integrations_list_azure_projects
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_list_bitbucketserver_projects Read
List the Bitbucket Server projects Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/list_bitbucketserver_projects.
- Lua path
app.integrations.sonarqube.alm_integrations_list_bitbucketserver_projects- Full name
sonarqube.sonarqube_alm_integrations_list_bitbucketserver_projects
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_search_azure_repos Read
Search the Azure repositories Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_azure_repos.
- Lua path
app.integrations.sonarqube.alm_integrations_search_azure_repos- Full name
sonarqube.sonarqube_alm_integrations_search_azure_repos
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_search_bitbucketcloud_repos Read
Search the Bitbucket Cloud repositories Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_bitbucketcloud_repos.
- Lua path
app.integrations.sonarqube.alm_integrations_search_bitbucketcloud_repos- Full name
sonarqube.sonarqube_alm_integrations_search_bitbucketcloud_repos
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_search_bitbucketserver_repos Read
Search the Bitbucket Server repositories with REPO_ADMIN access Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_bitbucketserver_repos.
- Lua path
app.integrations.sonarqube.alm_integrations_search_bitbucketserver_repos- Full name
sonarqube.sonarqube_alm_integrations_search_bitbucketserver_repos
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_search_gitlab_repos Read
Search the GitLab projects. Requires the 'Create Projects' permission Official SonarQube Web API endpoint: GET /api/alm_integrations/search_gitlab_repos.
- Lua path
app.integrations.sonarqube.alm_integrations_search_gitlab_repos- Full name
sonarqube.sonarqube_alm_integrations_search_gitlab_repos
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_integrations_set_pat Write
Set a Personal Access Token for the given DevOps Platform setting Requires the 'Create Projects' permission Official SonarQube Web API endpoint: POST /api/alm_integrations/set_pat.
- Lua path
app.integrations.sonarqube.alm_integrations_set_pat- Full name
sonarqube.sonarqube_alm_integrations_set_pat
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_count_binding Read
Count number of project bound to an DevOps Platform setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: GET /api/alm_settings/count_binding.
- Lua path
app.integrations.sonarqube.alm_settings_count_binding- Full name
sonarqube.sonarqube_alm_settings_count_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_create_azure Write
Create Azure instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_azure.
- Lua path
app.integrations.sonarqube.alm_settings_create_azure- Full name
sonarqube.sonarqube_alm_settings_create_azure
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_create_bitbucket Write
Create Bitbucket instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_bitbucket.
- Lua path
app.integrations.sonarqube.alm_settings_create_bitbucket- Full name
sonarqube.sonarqube_alm_settings_create_bitbucket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_create_bitbucketcloud Write
Configure a new instance of Bitbucket Cloud. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_bitbucketcloud.
- Lua path
app.integrations.sonarqube.alm_settings_create_bitbucketcloud- Full name
sonarqube.sonarqube_alm_settings_create_bitbucketcloud
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_create_github Write
Create GitHub instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_github.
- Lua path
app.integrations.sonarqube.alm_settings_create_github- Full name
sonarqube.sonarqube_alm_settings_create_github
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_create_gitlab Write
Create GitLab instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/create_gitlab.
- Lua path
app.integrations.sonarqube.alm_settings_create_gitlab- Full name
sonarqube.sonarqube_alm_settings_create_gitlab
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_delete Write
Delete an DevOps Platform Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/delete.
- Lua path
app.integrations.sonarqube.alm_settings_delete- Full name
sonarqube.sonarqube_alm_settings_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_delete_binding Write
Delete the DevOps Platform binding of a project. Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settings/delete_binding.
- Lua path
app.integrations.sonarqube.alm_settings_delete_binding- Full name
sonarqube.sonarqube_alm_settings_delete_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_get_binding Read
Get DevOps Platform binding of a given project. Requires the 'Browse' permission on the project Official SonarQube Web API endpoint: GET /api/alm_settings/get_binding.
- Lua path
app.integrations.sonarqube.alm_settings_get_binding- Full name
sonarqube.sonarqube_alm_settings_get_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_list Read
List DevOps Platform setting available for a given project, sorted by DevOps Platform key Requires the 'Administer project' permission if the 'project' parameter is provided, requires the 'Create Projects' permission otherwise. Official SonarQube Web API endp
- Lua path
app.integrations.sonarqube.alm_settings_list- Full name
sonarqube.sonarqube_alm_settings_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_list_definitions Read
List DevOps Platform Settings, sorted by created date. Requires the 'Administer System' permission Official SonarQube Web API endpoint: GET /api/alm_settings/list_definitions.
- Lua path
app.integrations.sonarqube.alm_settings_list_definitions- Full name
sonarqube.sonarqube_alm_settings_list_definitions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_set_azure_binding Write
Bind a Azure DevOps instance to a project. If the project was already bound to a previous Azure DevOps instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_
- Lua path
app.integrations.sonarqube.alm_settings_set_azure_binding- Full name
sonarqube.sonarqube_alm_settings_set_azure_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_set_bitbucket_binding Write
Bind a Bitbucket instance to a project. If the project was already bound to a previous Bitbucket instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settin
- Lua path
app.integrations.sonarqube.alm_settings_set_bitbucket_binding- Full name
sonarqube.sonarqube_alm_settings_set_bitbucket_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_set_bitbucketcloud_binding Write
Bind a Bitbucket Cloud setting to a project. If the project was already bound to a different Bitbucket Cloud setting, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api
- Lua path
app.integrations.sonarqube.alm_settings_set_bitbucketcloud_binding- Full name
sonarqube.sonarqube_alm_settings_set_bitbucketcloud_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_set_github_binding Write
Bind a GitHub instance to a project. If the project was already bound to a previous GitHub instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settings/set
- Lua path
app.integrations.sonarqube.alm_settings_set_github_binding- Full name
sonarqube.sonarqube_alm_settings_set_github_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_set_gitlab_binding Write
Bind a GitLab instance to a project. If the project was already bound to a previous Gitlab instance, the binding will be updated to the new one.Requires the 'Administer' permission on the project Official SonarQube Web API endpoint: POST /api/alm_settings/set
- Lua path
app.integrations.sonarqube.alm_settings_set_gitlab_binding- Full name
sonarqube.sonarqube_alm_settings_set_gitlab_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_update_azure Write
Update Azure instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_azure.
- Lua path
app.integrations.sonarqube.alm_settings_update_azure- Full name
sonarqube.sonarqube_alm_settings_update_azure
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_update_bitbucket Write
Update Bitbucket instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_bitbucket.
- Lua path
app.integrations.sonarqube.alm_settings_update_bitbucket- Full name
sonarqube.sonarqube_alm_settings_update_bitbucket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_update_bitbucketcloud Write
Update Bitbucket Cloud Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_bitbucketcloud.
- Lua path
app.integrations.sonarqube.alm_settings_update_bitbucketcloud- Full name
sonarqube.sonarqube_alm_settings_update_bitbucketcloud
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_update_github Write
Update GitHub instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_github.
- Lua path
app.integrations.sonarqube.alm_settings_update_github- Full name
sonarqube.sonarqube_alm_settings_update_github
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_update_gitlab Write
Update GitLab instance Setting. Requires the 'Administer System' permission Official SonarQube Web API endpoint: POST /api/alm_settings/update_gitlab.
- Lua path
app.integrations.sonarqube.alm_settings_update_gitlab- Full name
sonarqube.sonarqube_alm_settings_update_gitlab
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alm_settings_validate Read
Validate an DevOps Platform Setting by checking connectivity and permissions Requires the 'Administer System' permission Official SonarQube Web API endpoint: GET /api/alm_settings/validate.
- Lua path
app.integrations.sonarqube.alm_settings_validate- Full name
sonarqube.sonarqube_alm_settings_validate
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
analysis_cache_get Read
Get the scanner's cached data for a branch. Requires scan permission on the project. Data is returned gzipped if the corresponding 'Accept-Encoding' header is set in the request. Official SonarQube Web API endpoint: GET /api/analysis_cache/get.
- Lua path
app.integrations.sonarqube.analysis_cache_get- Full name
sonarqube.sonarqube_analysis_cache_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_add_project Write
Add a project to an application. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/add_project.
- Lua path
app.integrations.sonarqube.applications_add_project- Full name
sonarqube.sonarqube_applications_add_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_create Write
Create a new application. Requires 'Administer System' permission or 'Create Applications' permission Official SonarQube Web API endpoint: POST /api/applications/create.
- Lua path
app.integrations.sonarqube.applications_create- Full name
sonarqube.sonarqube_applications_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_create_branch Write
Create a new branch on a given application. Requires 'Administrator' permission on the application and 'Browse' permission on its child projects Official SonarQube Web API endpoint: POST /api/applications/create_branch.
- Lua path
app.integrations.sonarqube.applications_create_branch- Full name
sonarqube.sonarqube_applications_create_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_delete Write
Delete an application definition. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/delete.
- Lua path
app.integrations.sonarqube.applications_delete- Full name
sonarqube.sonarqube_applications_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_delete_branch Write
Delete a branch on a given application. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/delete_branch.
- Lua path
app.integrations.sonarqube.applications_delete_branch- Full name
sonarqube.sonarqube_applications_delete_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_remove_project Write
Remove a project from an application Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/remove_project.
- Lua path
app.integrations.sonarqube.applications_remove_project- Full name
sonarqube.sonarqube_applications_remove_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_set_tags Write
Set tags on a application. Requires the following permission: 'Administer' rights on the specified application Official SonarQube Web API endpoint: POST /api/applications/set_tags.
- Lua path
app.integrations.sonarqube.applications_set_tags- Full name
sonarqube.sonarqube_applications_set_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_show Read
Returns an application and its associated projects. Requires the 'Browse' permission on the application and on its child projects. Official SonarQube Web API endpoint: GET /api/applications/show.
- Lua path
app.integrations.sonarqube.applications_show- Full name
sonarqube.sonarqube_applications_show
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_update Write
Update an application. Requires 'Administrator' permission on the application Official SonarQube Web API endpoint: POST /api/applications/update.
- Lua path
app.integrations.sonarqube.applications_update- Full name
sonarqube.sonarqube_applications_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
applications_update_branch Write
Update a branch on a given application. Requires 'Administrator' permission on the application and 'Browse' permission on its child projects Official SonarQube Web API endpoint: POST /api/applications/update_branch.
- Lua path
app.integrations.sonarqube.applications_update_branch- Full name
sonarqube.sonarqube_applications_update_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
audit_logs_download Read
Returns security related audits of this SonarQube instance. Logs are returned in JSON format. Requires the system administration permission Official SonarQube Web API endpoint: GET /api/audit_logs/download.
- Lua path
app.integrations.sonarqube.audit_logs_download- Full name
sonarqube.sonarqube_audit_logs_download
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
authentication_login Write
Authenticate a user. Official SonarQube Web API endpoint: POST /api/authentication/login.
- Lua path
app.integrations.sonarqube.authentication_login- Full name
sonarqube.sonarqube_authentication_login
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
authentication_logout Write
Logout a user. Official SonarQube Web API endpoint: POST /api/authentication/logout.
- Lua path
app.integrations.sonarqube.authentication_logout- Full name
sonarqube.sonarqube_authentication_logout
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
authentication_validate Read
Check credentials. Official SonarQube Web API endpoint: GET /api/authentication/validate.
- Lua path
app.integrations.sonarqube.authentication_validate- Full name
sonarqube.sonarqube_authentication_validate
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ce_activity Read
Search for tasks. Requires the system administration permission, or project administration permission if component is set. Official SonarQube Web API endpoint: GET /api/ce/activity.
- Lua path
app.integrations.sonarqube.ce_activity- Full name
sonarqube.sonarqube_ce_activity
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ce_activity_status Read
Returns CE activity related metrics. Requires 'Administer System' permission or 'Administer' rights on the specified project. Official SonarQube Web API endpoint: GET /api/ce/activity_status.
- Lua path
app.integrations.sonarqube.ce_activity_status- Full name
sonarqube.sonarqube_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. Official SonarQube Web API endpoint: GET /api/ce/component.
- Lua path
app.integrations.sonarqube.ce_component- Full name
sonarqube.sonarqube_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 one of the following permissions: - 'Administer' at global or project level; - 'Execute Analysis' at global or project level; Since 6.1, field "logs" is deprecat
- Lua path
app.integrations.sonarqube.ce_task- Full name
sonarqube.sonarqube_ce_task
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
components_search Read
Search for components Official SonarQube Web API endpoint: GET /api/components/search.
- Lua path
app.integrations.sonarqube.components_search- Full name
sonarqube.sonarqube_components_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
components_show Read
Returns a component (file, directory, project, portfolio…) and its ancestors. The ancestors are ordered from the parent to the root project. Requires the following permission: 'Browse' on the project of the specified component. Official SonarQube Web API endp
- Lua path
app.integrations.sonarqube.components_show- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/components/t
- Lua path
app.integrations.sonarqube.components_tree- Full name
sonarqube.sonarqube_components_tree
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
duplications_show Read
Get duplications. Require Browse permission on file's project Official SonarQube Web API endpoint: GET /api/duplications/show.
- Lua path
app.integrations.sonarqube.duplications_show- Full name
sonarqube.sonarqube_duplications_show
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
editions_activate_grace_period Write
Enable a license 7-days grace period if the Server ID is invalid. Require 'Administer System' permission. Official SonarQube Web API endpoint: POST /api/editions/activate_grace_period.
- Lua path
app.integrations.sonarqube.editions_activate_grace_period- Full name
sonarqube.sonarqube_editions_activate_grace_period
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
editions_set_license Write
Set the license for enabling features of commercial editions. Require 'Administer System' permission. Official SonarQube Web API endpoint: POST /api/editions/set_license. Deprecated since SonarQube 2025.6; kept for API parity with servers that still expose i
- Lua path
app.integrations.sonarqube.editions_set_license- Full name
sonarqube.sonarqube_editions_set_license
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
favorites_add Write
Add a component (project, portfolio, etc.) as favorite for the authenticated user. Only 100 components by qualifier can be added as favorite. Requires authentication and the following permission: 'Browse' on the component. Official SonarQube Web API endpoint:
- Lua path
app.integrations.sonarqube.favorites_add- Full name
sonarqube.sonarqube_favorites_add
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
favorites_remove Write
Remove a component (project, portfolio, application etc.) as favorite for the authenticated user. Requires authentication. Official SonarQube Web API endpoint: POST /api/favorites/remove.
- Lua path
app.integrations.sonarqube.favorites_remove- Full name
sonarqube.sonarqube_favorites_remove
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
favorites_search Read
Search for the authenticated user favorites. Requires authentication. Official SonarQube Web API endpoint: GET /api/favorites/search.
- Lua path
app.integrations.sonarqube.favorites_search- Full name
sonarqube.sonarqube_favorites_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
hotspots_change_status Write
Change the status of a Security Hotpot. Requires the 'Administer Security Hotspot' permission. Official SonarQube Web API endpoint: POST /api/hotspots/change_status.
- Lua path
app.integrations.sonarqube.hotspots_change_status- Full name
sonarqube.sonarqube_hotspots_change_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
hotspots_search Read
Search for Security Hotpots. Requires the 'Browse' permission on the specified project(s). For applications, it also requires 'Browse' permission on its child projects. When issue indexing is in progress returns 503 service unavailable HTTP code. Official Son
- Lua path
app.integrations.sonarqube.hotspots_search- Full name
sonarqube.sonarqube_hotspots_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
hotspots_show Read
Provides the details of a Security Hotspot. Official SonarQube Web API endpoint: GET /api/hotspots/show.
- Lua path
app.integrations.sonarqube.hotspots_show- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/issues/add_comment.
- Lua path
app.integrations.sonarqube.issues_add_comment- Full name
sonarqube.sonarqube_issues_add_comment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_assign Write
Assign/Unassign an issue. Requires authentication and Browse permission on project Official SonarQube Web API endpoint: POST /api/issues/assign.
- Lua path
app.integrations.sonarqube.issues_assign- Full name
sonarqube.sonarqube_issues_assign
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_authors Read
Search SCM accounts which match a given query. Requires authentication. When issue indexing is in progress returns 503 service unavailable HTTP code. Official SonarQube Web API endpoint: GET /api/issues/authors.
- Lua path
app.integrations.sonarqube.issues_authors- Full name
sonarqube.sonarqube_issues_authors
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_bulk_change Write
Bulk change on issues. Up to 500 issues can be updated. Requires authentication. Official SonarQube Web API endpoint: POST /api/issues/bulk_change.
- Lua path
app.integrations.sonarqube.issues_bulk_change- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/issues/changelog.
- Lua path
app.integrations.sonarqube.issues_changelog- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/issues/delete_comment.
- Lua path
app.integrations.sonarqube.issues_delete_comment- Full name
sonarqube.sonarqube_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 permission
- Lua path
app.integrations.sonarqube.issues_do_transition- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/issues/edit_comment.
- Lua path
app.integrations.sonarqube.issues_edit_comment- Full name
sonarqube.sonarqube_issues_edit_comment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_gitlab_sast_export Read
Return a list of vulnerabilities according to the Gitlab SAST JSON format. The JSON produced can be used in GitLab for generating the Vulnerability Report.Requires the 'Browse' or 'Scan' permission on the specified project. Official SonarQube Web API endpoint
- Lua path
app.integrations.sonarqube.issues_gitlab_sast_export- Full name
sonarqube.sonarqube_issues_gitlab_sast_export
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_reindex Write
Reindex issues for a project. Require 'Administer System' permission. Official SonarQube Web API endpoint: POST /api/issues/reindex.
- Lua path
app.integrations.sonarqube.issues_reindex- Full name
sonarqube.sonarqube_issues_reindex
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_search Read
Search for issues. Requires the 'Browse' permission on the specified project(s). For applications, it also requires 'Browse' permission on its child projects. When issue indexing is in progress returns 503 service unavailable HTTP code. Official SonarQube Web
- Lua path
app.integrations.sonarqube.issues_search- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/issues/set_severity.
- Lua path
app.integrations.sonarqube.issues_set_severity- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/issues/set_tags.
- Lua path
app.integrations.sonarqube.issues_set_tags- Full name
sonarqube.sonarqube_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 SonarQube Web
- Lua path
app.integrations.sonarqube.issues_set_type- Full name
sonarqube.sonarqube_issues_set_type
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
issues_tags Read
List tags matching a given query Official SonarQube Web API endpoint: GET /api/issues/tags.
- Lua path
app.integrations.sonarqube.issues_tags- Full name
sonarqube.sonarqube_issues_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
languages_list Read
List supported programming languages Official SonarQube Web API endpoint: GET /api/languages/list.
- Lua path
app.integrations.sonarqube.languages_list- Full name
sonarqube.sonarqube_languages_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
measures_component Read
Return component with specified measures. Requires one of the following permissions:- 'Browse' on the project of the specified component; - 'Execute Analysis' on the project of the specified component; Official SonarQube Web API endpoint: GET /api/measures/co
- Lua path
app.integrations.sonarqube.measures_component- Full name
sonarqube.sonarqube_measures_component
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
measures_component_tree Read
Navigate through components based on the chosen strategy with specified measures. Requires the following permission: 'Browse' on the specified project. For applications, it also requires 'Browse' permission on its child projects. When limiting search with the
- Lua path
app.integrations.sonarqube.measures_component_tree- Full name
sonarqube.sonarqube_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. For applications, it also requires 'Browse' perm
- Lua path
app.integrations.sonarqube.measures_search_history- Full name
sonarqube.sonarqube_measures_search_history
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
metrics_search Read
Search for metrics Official SonarQube Web API endpoint: GET /api/metrics/search.
- Lua path
app.integrations.sonarqube.metrics_search- Full name
sonarqube.sonarqube_metrics_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
metrics_types Read
List all available metric types. Official SonarQube Web API endpoint: GET /api/metrics/types.
- Lua path
app.integrations.sonarqube.metrics_types- Full name
sonarqube.sonarqube_metrics_types
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
monitoring_metrics Read
Return monitoring metrics in Prometheus format. Support content type 'text/plain' (default) and 'application/openmetrics-text'. This endpoint can be accessed using a Bearer token, which needs to be defined in sonar.properties with the 'sonar.web.systemPasscode
- Lua path
app.integrations.sonarqube.monitoring_metrics- Full name
sonarqube.sonarqube_monitoring_metrics
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
new_code_periods_list Read
Lists the new code definition for all branches in a project. Requires the permission to browse the project Official SonarQube Web API endpoint: GET /api/new_code_periods/list.
- Lua path
app.integrations.sonarqube.new_code_periods_list- Full name
sonarqube.sonarqube_new_code_periods_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
new_code_periods_set Write
Updates the new code definition on different levels: - Not providing a project key and a branch key will update the default value at global level. Existing projects or branches having a specific new code definition will not be impacted; - Project key must be p
- Lua path
app.integrations.sonarqube.new_code_periods_set- Full name
sonarqube.sonarqube_new_code_periods_set
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
new_code_periods_show Read
Shows the new code definition. If the component requested doesn't exist or if no new code definition is set for it, a value is inherited from the project or from the global setting.Requires one of the following permissions if a component is specified: - 'Admin
- Lua path
app.integrations.sonarqube.new_code_periods_show- Full name
sonarqube.sonarqube_new_code_periods_show
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
new_code_periods_unset Write
Unsets the new code definition for a branch, project or global. It requires the inherited New Code Definition to be compatible with the Clean as You Code methodology, and one of the following permissions: - 'Administer System' to change the global setting; - '
- Lua path
app.integrations.sonarqube.new_code_periods_unset- Full name
sonarqube.sonarqube_new_code_periods_unset
| 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.; - System administration if a login is prov
- Lua path
app.integrations.sonarqube.notifications_add- Full name
sonarqube.sonarqube_notifications_add
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
notifications_list Read
List notifications of the authenticated user. Requires one of the following permissions: - Authentication if no login is provided; - System administration if a login is provided; Official SonarQube Web API endpoint: GET /api/notifications/list.
- Lua path
app.integrations.sonarqube.notifications_list- Full name
sonarqube.sonarqube_notifications_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
notifications_remove Write
Remove a notification for the authenticated user. Requires one of the following permissions: - Authentication if no login is provided; - System administration if a login is provided; Official SonarQube Web API endpoint: POST /api/notifications/remove.
- Lua path
app.integrations.sonarqube.notifications_remove- Full name
sonarqube.sonarqube_notifications_remove
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_add_group Write
Add a permission to a group. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key. The group name must be provided. Requires one of the following permissions:- 'Administer System'; - 'Adm
- Lua path
app.integrations.sonarqube.permissions_add_group- Full name
sonarqube.sonarqube_permissions_add_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_add_group_template Write
Add a group to a permission template. The group name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/add_group_to_template.
- Lua path
app.integrations.sonarqube.permissions_add_group_template- Full name
sonarqube.sonarqube_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 following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/add_project_creator_to_template.
- Lua path
app.integrations.sonarqube.permissions_add_project_creator_template- Full name
sonarqube.sonarqube_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 one of the following permissions:- 'Administer System'; - 'Administer' rights on the specified pro
- Lua path
app.integrations.sonarqube.permissions_add_user- Full name
sonarqube.sonarqube_permissions_add_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_add_user_template Write
Add a user to a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/add_user_to_template.
- Lua path
app.integrations.sonarqube.permissions_add_user_template- Full name
sonarqube.sonarqube_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 following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/apply_temp
- Lua path
app.integrations.sonarqube.permissions_apply_template- Full name
sonarqube.sonarqube_permissions_apply_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_bulk_apply_template Write
Apply a permission template to several components. Managed projects will be ignored. The template id or name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/bulk_apply_templa
- Lua path
app.integrations.sonarqube.permissions_bulk_apply_template- Full name
sonarqube.sonarqube_permissions_bulk_apply_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_create_template Write
Create a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/create_template.
- Lua path
app.integrations.sonarqube.permissions_create_template- Full name
sonarqube.sonarqube_permissions_create_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_delete_template Write
Delete a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/delete_template.
- Lua path
app.integrations.sonarqube.permissions_delete_template- Full name
sonarqube.sonarqube_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 name must be provided. Requires one of the following permissions:- 'Administer System'; -
- Lua path
app.integrations.sonarqube.permissions_remove_group- Full name
sonarqube.sonarqube_permissions_remove_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_remove_group_from_template Write
Remove a group from a permission template. The group name must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/remove_group_from_template.
- Lua path
app.integrations.sonarqube.permissions_remove_group_from_template- Full name
sonarqube.sonarqube_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 following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/remove_project_creator_from_template.
- Lua path
app.integrations.sonarqube.permissions_remove_project_creator_from_template- Full name
sonarqube.sonarqube_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 one of the following permissions:- 'Administer System'; - 'Administer' rights on the specifie
- Lua path
app.integrations.sonarqube.permissions_remove_user- Full name
sonarqube.sonarqube_permissions_remove_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_remove_user_from_template Write
Remove a user from a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/remove_user_from_template.
- Lua path
app.integrations.sonarqube.permissions_remove_user_from_template- Full name
sonarqube.sonarqube_permissions_remove_user_from_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_search_templates Read
List permission templates. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: GET /api/permissions/search_templates.
- Lua path
app.integrations.sonarqube.permissions_search_templates- Full name
sonarqube.sonarqube_permissions_search_templates
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_set_default_template Write
Set a permission template as default. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/set_default_template.
- Lua path
app.integrations.sonarqube.permissions_set_default_template- Full name
sonarqube.sonarqube_permissions_set_default_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
permissions_update_template Write
Update a permission template. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/permissions/update_template.
- Lua path
app.integrations.sonarqube.permissions_update_template- Full name
sonarqube.sonarqube_permissions_update_template
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_available Read
Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name. Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response. Update status
- Lua path
app.integrations.sonarqube.plugins_available- Full name
sonarqube.sonarqube_plugins_available
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_cancel_all Write
Cancels any operation pending on any plugin (install, update or uninstall) Requires user to be authenticated with Administer System permissions Official SonarQube Web API endpoint: POST /api/plugins/cancel_all.
- Lua path
app.integrations.sonarqube.plugins_cancel_all- Full name
sonarqube.sonarqube_plugins_cancel_all
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_install Write
Installs the latest version of a plugin specified by its key. Plugin information is retrieved from Update Center. Fails if used on commercial editions or plugin risk consent has not been accepted. Requires user to be authenticated with Administer System permis
- Lua path
app.integrations.sonarqube.plugins_install- Full name
sonarqube.sonarqube_plugins_install
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_installed Read
Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name. Requires authentication. Official SonarQube Web API endpoint: GET /api/plugins/installed.
- Lua path
app.integrations.sonarqube.plugins_installed- Full name
sonarqube.sonarqube_plugins_installed
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_pending Read
Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name. Require 'Administer System' permission. Official SonarQube Web API endpoint: GET /api/plugins/pending.
- Lua path
app.integrations.sonarqube.plugins_pending- Full name
sonarqube.sonarqube_plugins_pending
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_uninstall Write
Uninstalls the plugin specified by its key. Requires user to be authenticated with Administer System permissions. Official SonarQube Web API endpoint: POST /api/plugins/uninstall.
- Lua path
app.integrations.sonarqube.plugins_uninstall- Full name
sonarqube.sonarqube_plugins_uninstall
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_update Write
Updates a plugin specified by its key to the latest version compatible with the SonarQube instance. Plugin information is retrieved from Update Center. Requires user to be authenticated with Administer System permissions Official SonarQube Web API endpoint: P
- Lua path
app.integrations.sonarqube.plugins_update- Full name
sonarqube.sonarqube_plugins_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
plugins_updates Read
Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name. Each newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status. Plugin information is ret
- Lua path
app.integrations.sonarqube.plugins_updates- Full name
sonarqube.sonarqube_plugins_updates
| 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 one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified project; Official SonarQube Web API endpoint: POST /api/proj
- Lua path
app.integrations.sonarqube.project_analyses_create_event- Full name
sonarqube.sonarqube_project_analyses_create_event
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_analyses_delete Write
Delete a project analysis. Requires one of the following permissions: - 'Administer System'; - 'Administer' rights on the project of the specified analysis; Official SonarQube Web API endpoint: POST /api/project_analyses/delete.
- Lua path
app.integrations.sonarqube.project_analyses_delete- Full name
sonarqube.sonarqube_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 one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified project; Official SonarQube Web API endpoint: POST /api/proj
- Lua path
app.integrations.sonarqube.project_analyses_delete_event- Full name
sonarqube.sonarqube_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. For applications, it also requires 'Browse' permission on its child projects. Official SonarQube Web API endpoint: GET /api/project_analyses/s
- Lua path
app.integrations.sonarqube.project_analyses_search- Full name
sonarqube.sonarqube_project_analyses_search
| 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 one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified project; Official SonarQube Web API endpoint: POST /api/pro
- Lua path
app.integrations.sonarqube.project_analyses_update_event- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/project_badges/ai_code_assurance.
- Lua path
app.integrations.sonarqube.project_badges_ai_code_assurance- Full name
sonarqube.sonarqube_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 'Browse' permission on the specified project. Official SonarQube Web API endpoint: GET /api/project_badges/measure.
- Lua path
app.integrations.sonarqube.project_badges_measure- Full name
sonarqube.sonarqube_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 'Browse' permission on the specified project. Official SonarQube Web API endpoint: GET /api/project_badges/quality_gate.
- Lua path
app.integrations.sonarqube.project_badges_quality_gate- Full name
sonarqube.sonarqube_project_badges_quality_gate
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_badges_renew_token Write
Creates new token replacing any existing token for project or application badge access for private projects and applications. This token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints. Requires 'Admini
- Lua path
app.integrations.sonarqube.project_badges_renew_token- Full name
sonarqube.sonarqube_project_badges_renew_token
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_badges_token Read
Retrieve a token to use for project or application badge access for private projects or applications. This token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints. Requires 'Browse' permission on the spec
- Lua path
app.integrations.sonarqube.project_badges_token- Full name
sonarqube.sonarqube_project_badges_token
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_branches_delete Write
Delete a non-main branch of a project or application. Requires 'Administer' rights on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/delete.
- Lua path
app.integrations.sonarqube.project_branches_delete- Full name
sonarqube.sonarqube_project_branches_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_branches_list Read
List the branches of a project or application. Requires 'Browse' or 'Execute analysis' rights on the specified project or application. Official SonarQube Web API endpoint: GET /api/project_branches/list.
- Lua path
app.integrations.sonarqube.project_branches_list- Full name
sonarqube.sonarqube_project_branches_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_branches_rename Write
Rename the main branch of a project or application. Requires 'Administer' permission on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/rename.
- Lua path
app.integrations.sonarqube.project_branches_rename- Full name
sonarqube.sonarqube_project_branches_rename
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_branches_set_automatic_deletion_protection Write
Protect a specific branch from automatic deletion. Protection can't be disabled for the main branch. Requires 'Administer' permission on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/set_automatic_deleti
- Lua path
app.integrations.sonarqube.project_branches_set_automatic_deletion_protection- Full name
sonarqube.sonarqube_project_branches_set_automatic_deletion_protection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_branches_set_main Write
Allow to set a new main branch. . Caution, only applicable on projects. Requires 'Administer' rights on the specified project or application. Official SonarQube Web API endpoint: POST /api/project_branches/set_main.
- Lua path
app.integrations.sonarqube.project_branches_set_main- Full name
sonarqube.sonarqube_project_branches_set_main
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_dump_export Write
Triggers project dump so that the project can be imported to another SonarQube server (see api/project_dump/import, available in Enterprise Edition). Requires the 'Administer' permission. Official SonarQube Web API endpoint: POST /api/project_dump/export.
- Lua path
app.integrations.sonarqube.project_dump_export- Full name
sonarqube.sonarqube_project_dump_export
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_dump_import Write
Triggers the import of a project dump. Permission 'Administer' is required. This feature is provided by the Governance plugin. Official SonarQube Web API endpoint: POST /api/project_dump/import.
- Lua path
app.integrations.sonarqube.project_dump_import- Full name
sonarqube.sonarqube_project_dump_import
| 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 SonarQube Web API endpoint: POST /api/project_links/create.
- Lua path
app.integrations.sonarqube.project_links_create- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/project_links/delete.
- Lua path
app.integrations.sonarqube.project_links_delete- Full name
sonarqube.sonarqube_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 System'; - 'Administer' rights on the specified project; - 'Browse' on the specified project; Official SonarQube Web API endpoin
- Lua path
app.integrations.sonarqube.project_links_search- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/project_pull_requests/delete.
- Lua path
app.integrations.sonarqube.project_pull_requests_delete- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/project_pull_requests/list.
- Lua path
app.integrations.sonarqube.project_pull_requests_list- Full name
sonarqube.sonarqube_project_pull_requests_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
project_tags_search Read
Search tags Official SonarQube Web API endpoint: GET /api/project_tags/search.
- Lua path
app.integrations.sonarqube.project_tags_search- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/project_tags/set.
- Lua path
app.integrations.sonarqube.project_tags_set- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /a
- Lua path
app.integrations.sonarqube.projects_bulk_delete- Full name
sonarqube.sonarqube_projects_bulk_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_create Write
Create a project. If your project is hosted on a DevOps Platform, please use the import endpoint under api/alm_integrations, so it creates and properly configures the project.Requires 'Create Projects' permission. Official SonarQube Web API endpoint: POST /ap
- Lua path
app.integrations.sonarqube.projects_create- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/projects/delete.
- Lua path
app.integrations.sonarqube.projects_delete- Full name
sonarqube.sonarqube_projects_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_export_findings Read
Export all findings (issues and hotspots) of a specific project branch. Requires 'Administer System' permission. Keep in mind that this endpoint will return all findings, issues and hotspots (no filter), which can take time and use a lot of resources on the So
- Lua path
app.integrations.sonarqube.projects_export_findings- Full name
sonarqube.sonarqube_projects_export_findings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_get_contains_ai_code Read
Get whether a project contains AI code or not Official SonarQube Web API endpoint: GET /api/projects/get_contains_ai_code.
- Lua path
app.integrations.sonarqube.projects_get_contains_ai_code- Full name
sonarqube.sonarqube_projects_get_contains_ai_code
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_license_usage Read
Help admins to understand how much each project affects the total number of lines of code. Returns the list of projects together with information about their usage, sorted by lines of code descending. Requires Administer System permission. Official SonarQube
- Lua path
app.integrations.sonarqube.projects_license_usage- Full name
sonarqube.sonarqube_projects_license_usage
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_search Read
Search for projects or views to administrate them. - The response field 'lastAnalysisDate' takes into account the analysis of all branches and pull requests, not only the main branch.; - The response field 'revision' takes into account the analysis of the main
- Lua path
app.integrations.sonarqube.projects_search- Full name
sonarqube.sonarqube_projects_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_set_contains_ai_code Write
Sets if the project passed as parameter contains or not AI code according to the value of the contains_ai_code parameter. Requires 'Administer' rights on the specified project. Official SonarQube Web API endpoint: POST /api/projects/set_contains_ai_code.
- Lua path
app.integrations.sonarqube.projects_set_contains_ai_code- Full name
sonarqube.sonarqube_projects_set_contains_ai_code
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_update_key Write
Update a project all its sub-components keys. Requires 'Administer' permission on the project. Official SonarQube Web API endpoint: POST /api/projects/update_key.
- Lua path
app.integrations.sonarqube.projects_update_key- Full name
sonarqube.sonarqube_projects_update_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
projects_update_visibility Write
Updates visibility of a project, application or a portfolio. Requires 'Project administer' permission on the specified entity Official SonarQube Web API endpoint: POST /api/projects/update_visibility.
- Lua path
app.integrations.sonarqube.projects_update_visibility- Full name
sonarqube.sonarqube_projects_update_visibility
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_add_group Write
Allow a group of users to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/add_group.
- Lua path
app.integrations.sonarqube.qualitygates_add_group- Full name
sonarqube.sonarqube_qualitygates_add_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_add_user Write
Allow a user to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/add_user.
- Lua path
app.integrations.sonarqube.qualitygates_add_user- Full name
sonarqube.sonarqube_qualitygates_add_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_copy Write
Copy a Quality Gate. 'sourceName' must be provided. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/copy.
- Lua path
app.integrations.sonarqube.qualitygates_copy- Full name
sonarqube.sonarqube_qualitygates_copy
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_create Write
Create a Quality Gate. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/create.
- Lua path
app.integrations.sonarqube.qualitygates_create- Full name
sonarqube.sonarqube_qualitygates_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_create_condition Write
Add a new condition to a quality gate. Parameter 'gateName' must be provided. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/create_condition.
- Lua path
app.integrations.sonarqube.qualitygates_create_condition- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualitygates/delete_condition.
- Lua path
app.integrations.sonarqube.qualitygates_delete_condition- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualitygates/deselect.
- Lua path
app.integrations.sonarqube.qualitygates_deselect- Full name
sonarqube.sonarqube_qualitygates_deselect
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_destroy Write
Delete a Quality Gate. Parameter 'name' must be specified. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/destroy.
- Lua path
app.integrations.sonarqube.qualitygates_destroy- Full name
sonarqube.sonarqube_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 System'; - 'Administer' rights on the specified project; - 'Browse' on the specified project; Official SonarQube Web API endpoint: GET /api/qualitygates/get_by_project.
- Lua path
app.integrations.sonarqube.qualitygates_get_by_project- Full name
sonarqube.sonarqube_qualitygates_get_by_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_list Read
Get a list of quality gates Official SonarQube Web API endpoint: GET /api/qualitygates/list.
- Lua path
app.integrations.sonarqube.qualitygates_list- Full name
sonarqube.sonarqube_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.sonarqube.qualitygates_project_status- Full name
sonarqube.sonarqube_qualitygates_project_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_remove_group Write
Remove the ability from a group to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/remove_group.
- Lua path
app.integrations.sonarqube.qualitygates_remove_group- Full name
sonarqube.sonarqube_qualitygates_remove_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_remove_user Write
Remove the ability from an user to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: POST /api/qualitygates/remove_user.
- Lua path
app.integrations.sonarqube.qualitygates_remove_user- Full name
sonarqube.sonarqube_qualitygates_remove_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_rename Write
Rename a Quality Gate. 'currentName' must be specified. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/rename.
- Lua path
app.integrations.sonarqube.qualitygates_rename- Full name
sonarqube.sonarqube_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 the current user will be returned. Official SonarQube Web API endpoint: GET /api/qualitygates/search.
- Lua path
app.integrations.sonarqube.qualitygates_search- Full name
sonarqube.sonarqube_qualitygates_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_search_groups Read
List the groups that are allowed to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: GET /api/qualitygates/search_groups.
- Lua path
app.integrations.sonarqube.qualitygates_search_groups- Full name
sonarqube.sonarqube_qualitygates_search_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_search_users Read
List the users that are allowed to edit a Quality Gate. Requires one of the following permissions: - 'Administer Quality Gates'; - Edit right on the specified quality gate; Official SonarQube Web API endpoint: GET /api/qualitygates/search_users.
- Lua path
app.integrations.sonarqube.qualitygates_search_users- Full name
sonarqube.sonarqube_qualitygates_search_users
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_select Write
Associate a project to a quality gate. Requires one of the following permissions: - 'Administer Quality Gates'; - 'Administer' right on the specified project; Official SonarQube Web API endpoint: POST /api/qualitygates/select.
- Lua path
app.integrations.sonarqube.qualitygates_select- Full name
sonarqube.sonarqube_qualitygates_select
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_set_default Write
Set a quality gate as the default quality gate. Parameter 'name' must be specified. Requires the 'Administer Quality Gates' permission. Official SonarQube Web API endpoint: POST /api/qualitygates/set_as_default.
- Lua path
app.integrations.sonarqube.qualitygates_set_default- Full name
sonarqube.sonarqube_qualitygates_set_as_default
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualitygates_show Read
Display the details of a quality gate Official SonarQube Web API endpoint: GET /api/qualitygates/show.
- Lua path
app.integrations.sonarqube.qualitygates_show- Full name
sonarqube.sonarqube_qualitygates_show
| 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 SonarQube Web API endpoint: POST /api/qualitygates/update_condition.
- Lua path
app.integrations.sonarqube.qualitygates_update_condition- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/activate_rule.
- Lua path
app.integrations.sonarqube.qualityprofiles_activate_rule- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/activate_rules.
- Lua path
app.integrations.sonarqube.qualityprofiles_activate_rules- Full name
sonarqube.sonarqube_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'; - Administer right on the specified project; Official SonarQube Web API endpoint: POST /api/qualityprofiles/add_project.
- Lua path
app.integrations.sonarqube.qualityprofiles_add_project- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/qualityprofiles/backup.
- Lua path
app.integrations.sonarqube.qualityprofiles_backup- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/change_parent.
- Lua path
app.integrations.sonarqube.qualityprofiles_change_parent- Full name
sonarqube.sonarqube_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/impacts. Events are ordered by date in descending order (most recent first). Official SonarQube Web API endpoint: GET /api/qualityprofiles/changelog.
- Lua path
app.integrations.sonarqube.qualityprofiles_changelog- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/copy.
- Lua path
app.integrations.sonarqube.qualityprofiles_copy- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/create.
- Lua path
app.integrations.sonarqube.qualityprofiles_create- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/deactivate_rule.
- Lua path
app.integrations.sonarqube.qualityprofiles_deactivate_rule- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/deactivate_rules.
- Lua path
app.integrations.sonarqube.qualityprofiles_deactivate_rules- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: PO
- Lua path
app.integrations.sonarqube.qualityprofiles_delete- Full name
sonarqube.sonarqube_qualityprofiles_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualityprofiles_export Read
Export a quality profile. Official SonarQube Web API endpoint: GET /api/qualityprofiles/export. Deprecated since SonarQube 25.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.qualityprofiles_export- Full name
sonarqube.sonarqube_qualityprofiles_export
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualityprofiles_exporters Read
Deprecated. No more custom profile exporters. Official SonarQube Web API endpoint: GET /api/qualityprofiles/exporters. Deprecated since SonarQube 25.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.qualityprofiles_exporters- Full name
sonarqube.sonarqube_qualityprofiles_exporters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualityprofiles_importers Read
List supported importers. Official SonarQube Web API endpoint: GET /api/qualityprofiles/importers. Deprecated since SonarQube 25.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.qualityprofiles_importers- Full name
sonarqube.sonarqube_qualityprofiles_importers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualityprofiles_inheritance Read
Show a quality profile's ancestors and children. Official SonarQube Web API endpoint: GET /api/qualityprofiles/inheritance.
- Lua path
app.integrations.sonarqube.qualityprofiles_inheritance- Full name
sonarqube.sonarqube_qualityprofiles_inheritance
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualityprofiles_projects Read
List projects with their association status regarding a quality profile. Only projects explicitly bound to the profile are returned, those associated with the profile because it is the default one are not. See api/qualityprofiles/search in order to get the Qua
- Lua path
app.integrations.sonarqube.qualityprofiles_projects- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint:
- Lua path
app.integrations.sonarqube.qualityprofiles_remove_project- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/rename.
- Lua path
app.integrations.sonarqube.qualityprofiles_rename- Full name
sonarqube.sonarqube_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.sonarqube.qualityprofiles_restore- Full name
sonarqube.sonarqube_qualityprofiles_restore
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
qualityprofiles_search Read
Search quality profiles Official SonarQube Web API endpoint: GET /api/qualityprofiles/search.
- Lua path
app.integrations.sonarqube.qualityprofiles_search- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/qualityprofiles/set_default.
- Lua path
app.integrations.sonarqube.qualityprofiles_set_default- Full name
sonarqube.sonarqube_qualityprofiles_set_default
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_create Write
Create a custom rule. Requires the 'Administer Quality Profiles' permission Official SonarQube Web API endpoint: POST /api/rules/create.
- Lua path
app.integrations.sonarqube.rules_create- Full name
sonarqube.sonarqube_rules_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_delete Write
Delete custom rule. Requires the 'Administer Quality Profiles' permission Official SonarQube Web API endpoint: POST /api/rules/delete.
- Lua path
app.integrations.sonarqube.rules_delete- Full name
sonarqube.sonarqube_rules_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_repositories Read
List available rule repositories Official SonarQube Web API endpoint: GET /api/rules/repositories.
- Lua path
app.integrations.sonarqube.rules_repositories- Full name
sonarqube.sonarqube_rules_repositories
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_search Read
Search for a collection of relevant rules matching a specified query. Official SonarQube Web API endpoint: GET /api/rules/search.
- Lua path
app.integrations.sonarqube.rules_search- Full name
sonarqube.sonarqube_rules_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_show Read
Get detailed information about a rule Official SonarQube Web API endpoint: GET /api/rules/show.
- Lua path
app.integrations.sonarqube.rules_show- Full name
sonarqube.sonarqube_rules_show
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_tags Read
List rule tags Official SonarQube Web API endpoint: GET /api/rules/tags.
- Lua path
app.integrations.sonarqube.rules_tags- Full name
sonarqube.sonarqube_rules_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
rules_update Write
Update an existing rule. Requires the 'Administer Quality Profiles' permission Official SonarQube Web API endpoint: POST /api/rules/update.
- Lua path
app.integrations.sonarqube.rules_update- Full name
sonarqube.sonarqube_rules_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
server_version Read
Version of SonarQube in plain text Official SonarQube Web API endpoint: GET /api/server/version.
- Lua path
app.integrations.sonarqube.server_version- Full name
sonarqube.sonarqube_server_version
| 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 System';
- Lua path
app.integrations.sonarqube.settings_list_definitions- Full name
sonarqube.sonarqube_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 one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified component; Official SonarQube Web API endpoint:
- Lua path
app.integrations.sonarqube.settings_reset- Full name
sonarqube.sonarqube_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 one of the following permissions: - 'Administer System'; - 'Administer' rights on the specified comp
- Lua path
app.integrations.sonarqube.settings_set- Full name
sonarqube.sonarqube_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. The settings from conf/sonar.properties are excluded from results. Requires 'Browse' or 'Execute Analysis' permission when a component is specified. Secured setti
- Lua path
app.integrations.sonarqube.settings_values- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/sources/raw.
- Lua path
app.integrations.sonarqube.sources_raw- Full name
sonarqube.sonarqube_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.sonarqube.sources_scm- Full name
sonarqube.sonarqube_sources_scm
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
sources_show Read
Get source code. Requires See Source Code permission on file's project Each element of the result array is composed of:- Line number; - Content of the line; Official SonarQube Web API endpoint: GET /api/sources/show.
- Lua path
app.integrations.sonarqube.sources_show- Full name
sonarqube.sonarqube_sources_show
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_change_log_level Write
Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission. Official SonarQube Web API endpoint: POST /api/system/change_log_level.
- Lua path
app.integrations.sonarqube.system_change_log_level- Full name
sonarqube.sonarqube_system_change_log_level
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_db_migration_status Read
Display the database migration status of SonarQube. State values are:- NO_MIGRATION: DB is up to date with current version of SonarQube.; - NOT_SUPPORTED: Migration is not supported on embedded databases.; - MIGRATION_RUNNING: DB migration is under go.; - MIGR
- Lua path
app.integrations.sonarqube.system_db_migration_status- Full name
sonarqube.sonarqube_system_db_migration_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_health Read
Provide health status of SonarQube.Although global health is calculated based on both application and search nodes, detailed information is returned only for application nodes. - GREEN: SonarQube is fully operational; - YELLOW: SonarQube is usable, but it need
- Lua path
app.integrations.sonarqube.system_health- Full name
sonarqube.sonarqube_system_health
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_info Read
Get detailed information about system configuration. Requires 'Administer' permissions. Official SonarQube Web API endpoint: GET /api/system/info.
- Lua path
app.integrations.sonarqube.system_info- Full name
sonarqube.sonarqube_system_info
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_logs Read
Get system logs in plain-text format. Requires system administration permission. Official SonarQube Web API endpoint: GET /api/system/logs.
- Lua path
app.integrations.sonarqube.system_logs- Full name
sonarqube.sonarqube_system_logs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_migrate_db Write
Migrate the database to match the current version of SonarQube. Sending a POST request to this URL starts the DB migration. It is strongly advised to make a database backup before invoking this WS. State values are:- NO_MIGRATION: DB is up to date with current
- Lua path
app.integrations.sonarqube.system_migrate_db- Full name
sonarqube.sonarqube_system_migrate_db
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_ping Read
Answers "pong" as plain-text Official SonarQube Web API endpoint: GET /api/system/ping.
- Lua path
app.integrations.sonarqube.system_ping- Full name
sonarqube.sonarqube_system_ping
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_restart Write
Restarts server. Requires 'Administer System' permission. Performs a full restart of the Web, Search and Compute Engine Servers processes. Does not reload sonar.properties. Official SonarQube Web API endpoint: POST /api/system/restart.
- Lua path
app.integrations.sonarqube.system_restart- Full name
sonarqube.sonarqube_system_restart
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_status Read
Get state information about SonarQube.status: the running status - STARTING: SonarQube Web Server is up and serving some Web Services (eg. api/system/status) but initialization is still ongoing; - UP: SonarQube instance is up and running; - DOWN: SonarQube ins
- Lua path
app.integrations.sonarqube.system_status- Full name
sonarqube.sonarqube_system_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
system_upgrades Read
Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade. Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in
- Lua path
app.integrations.sonarqube.system_upgrades- Full name
sonarqube.sonarqube_system_upgrades
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_groups_add_user Write
Add a user to a group. 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/add_user. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose i
- Lua path
app.integrations.sonarqube.user_groups_add_user- Full name
sonarqube.sonarqube_user_groups_add_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_groups_create Write
Create a group. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/create. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.user_groups_create- Full name
sonarqube.sonarqube_user_groups_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_groups_delete Write
Delete a group. The default groups cannot be deleted. 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/delete. Deprecated since SonarQube 10.4; kept for API parity wit
- Lua path
app.integrations.sonarqube.user_groups_delete- Full name
sonarqube.sonarqube_user_groups_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_groups_remove_user Write
Remove a user from a group. 'name' must be provided. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/remove_user. Deprecated since SonarQube 10.4; kept for API parity with servers that still
- Lua path
app.integrations.sonarqube.user_groups_remove_user- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/user_groups/search. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.user_groups_search- Full name
sonarqube.sonarqube_user_groups_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_groups_update Write
Update a group. Requires the following permission: 'Administer System'. Official SonarQube Web API endpoint: POST /api/user_groups/update. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.user_groups_update- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/user_groups/users. Deprecated since SonarQube 10.4; kept for API parity with servers t
- Lua path
app.integrations.sonarqube.user_groups_users- Full name
sonarqube.sonarqube_user_groups_users
| 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. It requires administration permissions to specify a 'login' and generate a token for another user. Otherwise, a token is generated for the current u
- Lua path
app.integrations.sonarqube.user_tokens_generate- Full name
sonarqube.sonarqube_user_tokens_generate
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_tokens_revoke Write
Revoke a user access token. It requires administration permissions to specify a 'login' and revoke a token for another user. Otherwise, the token for the current user is revoked. Official SonarQube Web API endpoint: POST /api/user_tokens/revoke.
- Lua path
app.integrations.sonarqube.user_tokens_revoke- Full name
sonarqube.sonarqube_user_tokens_revoke
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
user_tokens_search Read
List the access tokens of a user. The login must exist and active. Field 'lastConnectionDate' is only updated every hour, so it may not be accurate, for instance when a user is using a token many times in less than one hour. It requires administration permissi
- Lua path
app.integrations.sonarqube.user_tokens_search- Full name
sonarqube.sonarqube_user_tokens_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_anonymize Write
Anonymize a deactivated user. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/anonymize. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.users_anonymize- Full name
sonarqube.sonarqube_users_anonymize
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_change_password Write
Update a user's password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user's password. Official SonarQube Web API e
- Lua path
app.integrations.sonarqube.users_change_password- Full name
sonarqube.sonarqube_users_change_password
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_create Write
Create a user. If a deactivated user account exists with the given login, it will be reactivated. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/create. Deprecated since SonarQube 10.4; kept for API parity with ser
- Lua path
app.integrations.sonarqube.users_create- Full name
sonarqube.sonarqube_users_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_deactivate Write
Deactivate a user. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/deactivate. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.users_deactivate- Full name
sonarqube.sonarqube_users_deactivate
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_groups Read
Lists the groups a user belongs to. Requires Administer System permission. Official SonarQube Web API endpoint: GET /api/users/groups. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.users_groups- Full name
sonarqube.sonarqube_users_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_search Read
Get a list of users. By default, only active users are returned. The following fields are only returned when user has Administer System permission or for logged-in in user : - 'email'; - 'externalIdentity'; - 'externalProvider'; - 'groups'; - 'lastConnectionDa
- Lua path
app.integrations.sonarqube.users_search- Full name
sonarqube.sonarqube_users_search
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_update Write
Update a user. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/update. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.users_update- Full name
sonarqube.sonarqube_users_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_update_identity_provider Write
Update identity provider information. It's only possible to migrate to an installed identity provider. Be careful that as soon as this information has been updated for a user, the user will only be able to authenticate on the new identity provider. It is not p
- Lua path
app.integrations.sonarqube.users_update_identity_provider- Full name
sonarqube.sonarqube_users_update_identity_provider
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
users_update_login Write
Update a user login. A login can be updated many times. Requires Administer System permission Official SonarQube Web API endpoint: POST /api/users/update_login. Deprecated since SonarQube 10.4; kept for API parity with servers that still expose it.
- Lua path
app.integrations.sonarqube.users_update_login- Full name
sonarqube.sonarqube_users_update_login
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_add_application Write
Add an existing application to a portfolio. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: POST /api/views/add_application.
- Lua path
app.integrations.sonarqube.views_add_application- Full name
sonarqube.sonarqube_views_add_application
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_add_application_branch Write
Add a branch of an application selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the application. Official SonarQube Web API endpoint: POST /api/views/add_application_branch.
- Lua path
app.integrations.sonarqube.views_add_application_branch- Full name
sonarqube.sonarqube_views_add_application_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_add_portfolio Write
Add an existing portfolio to the structure of another portfolio. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: POST /api/views/add_portfolio.
- Lua path
app.integrations.sonarqube.views_add_portfolio- Full name
sonarqube.sonarqube_views_add_portfolio
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_add_project Write
Add a project to a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for adding project. Official SonarQube Web API endpoint: POST /api/views/add_project.
- Lua path
app.integrations.sonarqube.views_add_project- Full name
sonarqube.sonarqube_views_add_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_add_project_branch Write
Add a branch of a project selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the project. Official SonarQube Web API endpoint: POST /api/views/add_project_branch.
- Lua path
app.integrations.sonarqube.views_add_project_branch- Full name
sonarqube.sonarqube_views_add_project_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_applications Read
List applications which the user has access to that can be added to a portfolio. Authentication is required for this API endpoint Official SonarQube Web API endpoint: GET /api/views/applications.
- Lua path
app.integrations.sonarqube.views_applications- Full name
sonarqube.sonarqube_views_applications
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_create Write
Create a new portfolio. Requires 'Administer System' permission or 'Create Portfolios' permission, Official SonarQube Web API endpoint: POST /api/views/create.
- Lua path
app.integrations.sonarqube.views_create- Full name
sonarqube.sonarqube_views_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_delete Write
Delete a portfolio definition. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/delete.
- Lua path
app.integrations.sonarqube.views_delete- Full name
sonarqube.sonarqube_views_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_list Read
List root portfolios. Requires authentication. Only portfolios with the admin permission are returned. Official SonarQube Web API endpoint: GET /api/views/list.
- Lua path
app.integrations.sonarqube.views_list- Full name
sonarqube.sonarqube_views_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_move Write
Move a portfolio. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: POST /api/views/move.
- Lua path
app.integrations.sonarqube.views_move- Full name
sonarqube.sonarqube_views_move
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_move_options Read
List possible portfolio destinations. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: GET /api/views/move_options.
- Lua path
app.integrations.sonarqube.views_move_options- Full name
sonarqube.sonarqube_views_move_options
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_portfolios Read
List portfolios that can be referenced. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: GET /api/views/portfolios.
- Lua path
app.integrations.sonarqube.views_portfolios- Full name
sonarqube.sonarqube_views_portfolios
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_remove_application Write
Remove an application from a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/remove_application.
- Lua path
app.integrations.sonarqube.views_remove_application- Full name
sonarqube.sonarqube_views_remove_application
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_remove_application_branch Write
Remove a branch of an application selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the application. Official SonarQube Web API endpoint: POST /api/views/remove_application_branch.
- Lua path
app.integrations.sonarqube.views_remove_application_branch- Full name
sonarqube.sonarqube_views_remove_application_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_remove_portfolio Write
Remove a reference to a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/remove_portfolio.
- Lua path
app.integrations.sonarqube.views_remove_portfolio- Full name
sonarqube.sonarqube_views_remove_portfolio
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_remove_project Write
Remove a project from a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/remove_project.
- Lua path
app.integrations.sonarqube.views_remove_project- Full name
sonarqube.sonarqube_views_remove_project
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_remove_project_branch Write
Remove a branch of a project selected in a portfolio. Requires 'Administrator' permission on the portfolio and 'Browse' permission for the project. Official SonarQube Web API endpoint: POST /api/views/remove_project_branch.
- Lua path
app.integrations.sonarqube.views_remove_project_branch- Full name
sonarqube.sonarqube_views_remove_project_branch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_set_manual_mode Write
Set the projects selection mode of a portfolio on manual selection. In order to add project, please use api/view/add_project. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_manual_mode.
- Lua path
app.integrations.sonarqube.views_set_manual_mode- Full name
sonarqube.sonarqube_views_set_manual_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_set_none_mode Write
Set the projects selection mode of a portfolio to none. After setting this mode portfolio will not have any projects assigned. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_none_mode.
- Lua path
app.integrations.sonarqube.views_set_none_mode- Full name
sonarqube.sonarqube_views_set_none_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_set_regexp_mode Write
Set the projects selection mode of a portfolio on regular expression. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_regexp_mode.
- Lua path
app.integrations.sonarqube.views_set_regexp_mode- Full name
sonarqube.sonarqube_views_set_regexp_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_set_remaining_projects_mode Write
Set the projects selection mode of a portfolio on unassociated projects in hierarchy. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_remaining_projects_mode.
- Lua path
app.integrations.sonarqube.views_set_remaining_projects_mode- Full name
sonarqube.sonarqube_views_set_remaining_projects_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_set_tags_mode Write
Set the projects selection mode of a portfolio on project tags. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/set_tags_mode.
- Lua path
app.integrations.sonarqube.views_set_tags_mode- Full name
sonarqube.sonarqube_views_set_tags_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_show Read
Show the details of a portfolio, including its hierarchy and project selection mode. Authentication is required for this API endpoint. Official SonarQube Web API endpoint: GET /api/views/show.
- Lua path
app.integrations.sonarqube.views_show- Full name
sonarqube.sonarqube_views_show
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
views_update Write
Update a portfolio. Requires 'Administrator' permission on the portfolio. Official SonarQube Web API endpoint: POST /api/views/update.
- Lua path
app.integrations.sonarqube.views_update- Full name
sonarqube.sonarqube_views_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
webhooks_create Write
Create a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission. Official SonarQube Web API endpoint: POST /api/webhooks/create.
- Lua path
app.integrations.sonarqube.webhooks_create- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/webhooks/delete.
- Lua path
app.integrations.sonarqube.webhooks_delete- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/webhooks/de
- Lua path
app.integrations.sonarqube.webhooks_deliveries- Full name
sonarqube.sonarqube_webhooks_deliveries
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
webhooks_delivery Read
Get a webhook delivery by its id. Require 'Administer System' permission. Note that additional information are returned by api/webhooks/delivery. Official SonarQube Web API endpoint: GET /api/webhooks/delivery.
- Lua path
app.integrations.sonarqube.webhooks_delivery- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: GET /api/webhooks/list.
- Lua path
app.integrations.sonarqube.webhooks_list- Full name
sonarqube.sonarqube_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 SonarQube Web API endpoint: POST /api/webhooks/update.
- Lua path
app.integrations.sonarqube.webhooks_update- Full name
sonarqube.sonarqube_webhooks_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
webservices_list Read
List web services Official SonarQube Web API endpoint: GET /api/webservices/list.
- Lua path
app.integrations.sonarqube.webservices_list- Full name
sonarqube.sonarqube_webservices_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
webservices_response_example Read
Display web service response example Official SonarQube Web API endpoint: GET /api/webservices/response_example.
- Lua path
app.integrations.sonarqube.webservices_response_example- Full name
sonarqube.sonarqube_webservices_response_example
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||