Services

V1 API services

Each service is a field of the client, and a command of sonar-cli whose subcommands are its methods.

• applications (client.Applications)
  add-project, create, create-branch, delete, delete-branch, refresh, remove-project, search-all-projects, search-projects, set-tags, show, show-leak, update, update-branch
• audit-logs (client.AuditLogs)
  download
• alm-integrations (client.AlmIntegrations): Manages DevOps platform integrations and project imports
  check-pat, get-github-client-id, import-azure-project, import-bitbucket-cloud-repo, import-bitbucket-server-project, import-github-project, import-gitlab-project, list-azure-projects, list-bitbucket-server-projects, list-github-organizations, list-github-repositories, search-azure-repos, search-bitbucket-cloud-repos, search-bitbucket-server-repos, search-gitlab-repos, set-pat
• alm-settings (client.AlmSettings): Manages DevOps platform settings and bindings
  count-binding, create-azure, create-bitbucket, create-bitbucket-cloud, create-github, create-github-from-manifest, create-gitlab, delete, delete-binding, get-binding, list, list-definitions, set-azure-binding, set-bitbucket-binding, set-bitbucket-cloud-binding, set-github-binding, set-gitlab-binding, update-azure, update-bitbucket, update-bitbucket-cloud, update-github, update-gitlab
• analysis-cache (client.AnalysisCache): Manages scanner analysis cache data
  clear, get
• analysis-reports (client.AnalysisReports): Manages Compute Engine analysis report queue
  queue-status
• authentication (client.Authentication): Manages user authentication sessions
  login, logout
• batch (client.Batch): Provides scanner batch operation data
  get-file, get-index, get-project
• ce (client.Ce): Manages Compute Engine tasks and workers
  activity, activity-status, analysis-status, cancel, cancel-all, component, dismiss-analysis-warning, indexation-status, info, pause, resume, set-worker-count, submit, task, task-types, worker-count
• components (client.Components): Manages project components and navigation
  app, search, search-projects, show, suggestions, tree
• developers (client.Developers): Provides developer-specific event data
  search-events
• dismiss-message (client.DismissMessage): Manages dismissible UI messages
  check, dismiss
• duplications (client.Duplications): Manages code duplication data
  show
• emails (client.Emails): Manages email sending functionality
  send
• favorites (client.Favorites): Manages user favorite components
  add, remove, search
• features (client.Features): Lists available SonarQube features
  list
• github-provisioning (client.GithubProvisioning): Manages GitHub provisioning status
  check, status, sync
• governance-reports (client.GovernanceReports)
  download, status, subscribe, unsubscribe, update-frequency, update-recipients
• hotspots (client.Hotspots): Manages security hotspots
  add-comment, assign, change-status, delete-comment, edit-comment, list, list-all, migrate-to-issues, migration-status, pull, search, search-all, show
• issues (client.Issues): Manages code issues and their lifecycle
  add-comment, anticipated-transitions, assign, authors, bulk-change, changelog, component-tags, delete-comment, do-transition, edit-comment, gitlab-sast-export, list, list-all, pull, pull-taint, reindex, search, search-all, set-severity, set-tags, set-type, tags
• l10n (client.L10N): Manages localization and internationalization
  get-index
• editions (client.Editions)
  activate-grace-period, get, is-valid-license, set, unset-license
• languages (client.Languages): Lists programming languages
  list
• measures (client.Measures): Manages project measures and metrics data
  component, component-tree, search, search-history
• views (client.Views)
  add-application, add-application-branch, add-portfolio, add-project, add-project-branch, applications, create, delete, list, move, move-options, projects, projects-status, refresh, remove-application, remove-application-branch, remove-portfolio, remove-project, remove-project-branch, search, set-manual-mode, set-none-mode, set-regexp-mode, set-remaining-projects-mode, set-tags-mode, show, sub-portfolios, update
• metrics (client.Metrics): Manages metric definitions
  search, search-all, types
• monitoring (client.Monitoring): Provides system monitoring data
  metrics
• navigation (client.Navigation): Provides navigation-related data
  component, global, marketplace, settings
• new-code-periods (client.NewCodePeriods): Manages new code period definitions
  list, set, show, unset
• notifications (client.Notifications): Manages user notifications
  add, add-group, list, list-group-subscriptions, list-groups, remove, remove-group
• permissions (client.Permissions): Manages project and global permissions
  add-group, add-group-to-template, add-project-creator-to-template, add-user, add-user-to-template, apply-template, bulk-apply-template, create-template, delete-template, groups, groups-all, remove-group, remove-group-from-template, remove-project-creator-from-template, remove-user, remove-user-from-template, search-templates, set-default-template, template-groups, template-groups-all, template-users, template-users-all, update-template, users, users-all
• plugins (client.Plugins): Manages SonarQube plugins
  available, cancel-all, download, install, installed, pending, uninstall, update, updates
• project-analyses (client.ProjectAnalyses): Manages project analysis events
  create-event, delete, delete-event, search, search-all, update-event
• project-badges (client.ProjectBadges): Manages project badge generation
  ai-code-assurance, measure, quality-gate, renew-token, token
• project-branches (client.ProjectBranches): Manages project branches
  delete, get-ai-code-assurance, list, rename, set-automatic-deletion-protection, set-main
• project-dump (client.ProjectDump): Manages project data export and import
  export, import, status
• project-links (client.ProjectLinks): Manages project links
  create, delete, search
• project-pull-requests (client.ProjectPullRequests)
  delete, list
• project-tags (client.ProjectTags): Manages project tags
  search, set
• projects (client.Projects): Manages SonarQube projects
  bulk-delete, create, delete, export-findings, get-contains-ai-code, get-detected-ai-code, search, search-all, search-my-projects, search-my-projects-all, search-my-scannable-projects, set-contains-ai-code, update-default-visibility, update-key, update-visibility
• push (client.Push): Manages server-sent events for SonarLint
  sonarlint-events
• qualitygates (client.Qualitygates): Manages quality gates and conditions
  add-group, add-user, application-status, assign, copy, create, create-condition, delete, delete-condition, get-by-project, list, project-status, remove-group, remove-user, rename, search, search-all, search-groups, search-groups-all, search-users, search-users-all, set-ai-code-assurance, set-default, show, unassign, update-condition
• qualityprofiles (client.Qualityprofiles): Manages quality profiles and rule activation
  activate-rule, activate-rules, add-group, add-project, add-user, backup, change-parent, changelog, changelog-all, compare, copy, create, deactivate-rule, deactivate-rules, delete, export, exporters, importers, inheritance, projects, projects-all, remove-group, remove-project, remove-user, rename, restore, search, search-groups, search-groups-all, search-users, search-users-all, set-default, show
• regulatory-reports (client.RegulatoryReports)
  download
• rules (client.Rules): Manages coding rules
  app, create, delete, list, repositories, search, search-all, show, tags, update
• saml (client.Saml)
  validation, validation-init
• security-reports (client.SecurityReports)
  download, show
• scim-management (client.ScimManagement)
  disable, enable, status
• server (client.Server): Provides SonarQube server information
  version
• settings (client.Settings): Manages SonarQube settings
  check-secret-key, encrypt, generate-secret-key, list-definitions, login-message, reset, set, values
• sources (client.Sources): Manages source code viewing
  index, issue-snippets, lines, raw, scm, show
• support (client.Support)
  info
• system (client.System): Manages SonarQube system administration
  change-log-level, db-migration-status, health, info, liveness, logs, migrate-db, ping, restart, status, upgrades
• user-groups (client.UserGroups): Manages user groups
  add-user, create, delete, remove-user, search, search-all, update, users, users-all
• user-tokens (client.UserTokens): Manages user authentication tokens
  generate, revoke, search
• users (client.Users): Manages SonarQube users
  anonymize, change-password, create, current, deactivate, dismiss-notice, groups, groups-all, identity-providers, search, search-all, set-ai-tool-usage, set-homepage, update, update-identity-provider, update-login
• webhooks (client.Webhooks): Manages webhooks
  create, delete, deliveries, delivery, list, update
• webservices (client.Webservices): Provides API metadata
  list, response-example

V2 API services

The V2 services are grouped under client.V2. They are available in the Go SDK only.

CLI global flags

--output format      Output format: json, table, yaml (default json)
      --password string    Password for basic authentication (also read from SONAR_CLI_PASSWORD env var)
      --timeout duration   HTTP request timeout (default 30s)
      --token string       Authentication token (also read from SONAR_CLI_TOKEN env var)
      --url string         SonarQube server URL (also read from SONAR_CLI_URL env var)
      --username string    Username for basic authentication (also read from SONAR_CLI_USERNAME env var)