- Logout a user.
- Check credentials. Returns true for anonymous user.
- Returns CE activity related metrics.Requires 'Administer' permission on the specified project.
- Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project). Requires `Browse` permission on the specified component.
- Search for top-level components (projects) in the organization, filterable by name pattern and qualifier. Use this to find a project's key when you only know its name. For drilling into directories/files within a project, use `components_tree` instead.
- Returns a component (file, directory, project) and its ancestors. The ancestors are ordered from the parent to the root project. Requires the following permission: 'Browse' on the project of the specified component.
- 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.
- Get duplications. Require Browse permission on file's project
- Add a project as favorite for the authenticated user.Only 100 components can be added as favorite.Requires authentication and the following permission: 'Browse' on the project.
- Remove a component (project, directory, file etc.) as favorite for the authenticated user.Requires authentication.
- Search for the authenticated user favorites.Requires authentication.
- Search for Security Hotspots.
- Search SCM accounts which match a given query.Requires authentication.
- Search for issues.Requires the 'Browse' permission on the specified project(s).
- List tags matching a given query
- List supported programming languages
- Return component with specified measures. The componentId or the component parameter must be provided.Requires the following permission: 'Browse' on the project of specified component.
- Recursively walk a project's directory/file tree and return the specified measures (e.g. coverage, complexity, ncloc) for each descendant component. Use this when you need per-file or per-directory metrics across a project, not just the project-level totals (which is what `measures_component` returns). Required: `component` (project key) and `metricKeys` (comma-separated). Use `strategy` (`children`/`all`/`leaves`) to control how deep to recurse. Requires `Browse` on the project.
- 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
- Search for metrics
- List all available metric types.
- Add a notification for the authenticated user.Requires one of the following permissions: Authentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project. If a project is provided, requires the 'Browse' permission on the specified project.
- List notifications of the authenticated user
- Remove a notification for the authenticated user
- Add a project creator to a permission template.Requires the permission 'Administer' on the organization.
- Add permission to a user. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.Requires the permission 'Administer' on the specified project.
- Add a user to a permission template. Requires the permission 'Administer' on the organization.
- Apply a permission template to one project.The project id or project key must be provided.The template id or name must be provided.Requires the permission 'Administer' on the organization.
- Apply a permission template to **many** projects in one call — use this to roll out (or re-roll-out) a template across a whole project set, optionally filtered by `projects` (comma-separated keys), `q` (name pattern), `analyzedBefore`, or `onProvisionedOnly`. For a single-project apply, use `permissions_apply_template` instead. Required: `templateId` or (`templateName` + `organization`). Requires `Administer` on the organization.
- Create a new permission template — a reusable named bundle of permissions that can be applied to projects (via `permissions_apply_template` or `permissions_bulk_apply_template`). Required: `name` (unique within the org). Optional `description` and `projectKeyPattern` (regex that auto-matches projects to this template). Requires `Administer` on the organization.
- Delete a permission template.Requires the permission 'Administer' on the organization.
- Remove a project creator from a permission template.Requires the permission 'Administer' on the organization.
- Remove permission from a user. This service defaults to global permissions, but can be limited to project permissions by providing project id or project key. Requires the permission 'Administer' on the specified project.
- Remove a user from a permission template. Requires the permission 'Administer' on the organization.
- List the permission templates configured for the organization (each template is a reusable named bundle of permissions that can be applied to projects). Use this to discover available template ids/names before calling `permissions_apply_template`, `permissions_bulk_apply_template`, `permissions_update_template`, or any of the `permissions_*_template` actions. Requires `Administer` on the organization.
- Set a permission template as default.Requires the permission 'Administer' on the organization.
- Update a permission template.Requires the permission 'Administer' on the organization.
- Pin a version tag or release marker (an "event") onto a specific Sonar analysis. Use this to attach things like `v1.2.3` to the analysis that represents a release — these show up on the project timeline in the UI. Required: `analysis` (analysis key from `project_analyses_search`) and `name` (the label, e.g. `v1.2.3`). Optional `category` is `VERSION` (default) or `OTHER`. Requires `Administer` on the project.
- Delete a project analysis.Requires the permission 'Administer' on the project of the specified analysis.
- Remove a version tag / release marker (an "event") that was previously pinned to a Sonar analysis. Use this to clear a version label from the project timeline — does NOT delete the underlying analysis itself (use `project_analyses_delete` for that). Required: `event` (event key). Only events of category VERSION or OTHER can be deleted. Requires `Administer` on the project.
- Search a project analyses and attached events.Requires the following permission: 'Browse' on the specified project
- Unset any manually-set New Code Period baseline on a project or a long-lived branch.Unsetting a manual baseline restores the use of the `sonar.leak.period` setting.Requires the permission 'Administer' on the specified project.
- Rename an existing version tag / release marker (an "event") on a Sonar analysis — e.g. change `v1.2.3` to `v1.2.4`. Required: `event` (event key) and `name` (new label). Only events of category VERSION or OTHER can be updated. Requires `Administer` on the project.
- Generate a badge for project's AI assurance as an SVG.Requires 'Browse' permission on the specified project.
- Generate badge for project's measure as an SVG.Requires a security token for private projects.
- Generate badge for project's quality gate as an SVG.Requires a security token for private projects.
- Delete a non-main branch of a project.Requires 'Administer' rights on the specified project.
- List the branches of a project.The statistics are the overall counts on long branches, and the count of issues detected on the changed code on short branches, and are only provided if the project parameter is specified.If the project parameter is specified, requires the user to have 'Browse' or 'Execute analysis' rights on that project. Otherwise, only returns branches from projects on which this user has 'Browse' or 'Execute analysis' rights.
- Rename the main branch of a project.Requires 'Administer' permission on the specified project.
- Create a new project link.Requires 'Administer' permission on the specified project, or global 'Administer' permission.
- Delete existing project link.Requires 'Administer' permission on the specified project, or global 'Administer' permission.
- List links of a project. Exactly one of `projectId` or `projectKey` must be provided. Requires `Administer` or `Browse` permission on the specified project.
- Delete a pull request.Requires 'Administer' rights on the specified project.
- 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
- Search tags
- Set tags on a project.Requires the following permission: 'Administer' rights on the specified project
- 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
- Create a project.Requires 'Create Projects' permission
- Delete a project. Requires 'Administer System' permission or 'Administer' permission on the project.
- Search for projects. Results are filtered to projects the caller has access to.
- Update a project or module key and all its sub-components keys.Requires the permission 'Administer' on the specified project.
- Updates visibility of a project.Requires 'Project administer' permission on the specified project
- Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.
- Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first).
- Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission.
- Create a quality profile.Requires to be logged in and the 'Administer Quality Profiles' permission.
- 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
- Show a quality profile's ancestors and children. Provide either `key` alone, or the trio `language` + `qualityProfile` + `organization` together.
- List projects with their association status regarding a quality profile
- Search quality profiles
- List available rule repositories
- Search for a collection of relevant rules matching a specified query.Since 5.5, following fields in the response have been deprecated :"effortToFixDescription" becomes "gapDescription""debtRemFnCoeff" becomes "remFnGapMultiplier""defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier""debtRemFnOffset" becomes "remFnBaseEffort""defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort""debtOverloaded" becomes "remFnOverloaded"
- Get detailed information about a ruleSince 5.5, following fields in the response have been deprecated :"effortToFixDescription" becomes "gapDescription""debtRemFnCoeff" becomes "remFnGapMultiplier""defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier""debtRemFnOffset" becomes "remFnBaseEffort""defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort""debtOverloaded" becomes "remFnOverloaded"In 7.1, the field 'scope' has been added.
- List rule tags
- Update an existing rule.Requires the 'Administer Quality Profiles' permission
- List settings definitions.Requires 'Browse' permission when a component is specifiedTo access licensed settings, authentication is requiredTo access secured settings, one of the following permissions is required: 'Execute Analysis''Administer' rights on the specified component
- Remove a setting value.The settings defined in conf/sonar.properties are read-only and can't be changed.Requires the permission 'Administer' on the specified component.
- Add a user to a group. SonarCloud identifies the group by `name` + `organization` only; numeric group `id` is not accepted by this endpoint. Requires `Administer System`.
- Create a group.Requires the following permission: 'Administer System'.
- Delete a group. The default groups cannot be deleted. SonarCloud identifies the group by `name` + `organization` only; numeric group `id` is not accepted by this endpoint. Requires `Administer System`.
- Search for user groups.Requires the following permission: 'Administer System'.
- Update a group.Requires the following permission: 'Administer System'.
- Given a group name, list the users in that group (with selection/membership flags). Use this when the question is "who is in group Y?". For the reverse direction — "which groups does user X belong to?" — use `users_groups`. SonarCloud identifies the group by `name` + `organization` only; numeric group `id` is not accepted by this endpoint. Requires `Administer System`.
- Generate a user access token. Please keep your tokens secret. They enable you to authenticate and analyze projects. The endpoint generates a token for the logged in user.
- Revoke an access token of the authenticated user.
- List the access tokens of the authenticated user. Field 'lastConnectionDate' is only updated every hour, so it may not be accurate, for instance when a user is using a token many times in less than one hour.
- Given a user login, list every group that user is a member of. Use this when the question is "which groups does user X belong to?". For the reverse direction — "who is in group Y?" — use `user_groups_users`. Requires `Administer` on the organization.
- List web services
- Display web service response example
No matching actions