# SonarSource qualityprofiles API

**Canonical:** https://apis.io/apis/sonarsource/sonarsource-qualityprofiles-api/  
**Provider:** SonarSource — https://apis.io/providers/sonarsource/  
**Base URL:** https://sonarcloud.io/api  
**Documentation:** https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/web-api/

SonarSource qualityprofiles API is one of 33 APIs that [SonarSource](https://apis.io/providers/sonarsource/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include qualityprofiles. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

Manage quality profiles.

## Operations (22)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/qualityprofiles/activate_rule` | Activate a rule on a Quality Profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit r... |
| POST | `/api/qualityprofiles/activate_rules` | Bulk-activate rules on one quality profile. Requires one of the following permissions: 'Administer Quality Profiles' ... |
| POST | `/api/qualityprofiles/add_project` | Associate a project with a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' ... |
| GET | `/api/qualityprofiles/backup` | Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore. |
| POST | `/api/qualityprofiles/change_parent` | Change a quality profile's parent. Requires one of the following permissions: 'Administer Quality Profiles' Edit righ... |
| GET | `/api/qualityprofiles/changelog` | Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events ... |
| POST | `/api/qualityprofiles/copy` | Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. |
| POST | `/api/qualityprofiles/create` | Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission. |
| POST | `/api/qualityprofiles/deactivate_rule` | Deactivate a rule on a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit... |
| POST | `/api/qualityprofiles/deactivate_rules` | Bulk deactivate rules on Quality profiles. Requires one of the following permissions: 'Administer Quality Profiles' E... |
| POST | `/api/qualityprofiles/delete` | Delete a quality profile and all its descendants. The default quality profile cannot be deleted. Requires one of the ... |
| GET | `/api/qualityprofiles/export` | Deprecated. Use GET /api/qualityprofiles/backup instead |
| GET | `/api/qualityprofiles/exporters` | Deprecated. No more custom profile exporters. |
| GET | `/api/qualityprofiles/importers` | Deprecated. No more custom profile importers. |
| GET | `/api/qualityprofiles/inheritance` | Show a quality profile's ancestors and children. |
| GET | `/api/qualityprofiles/projects` | List projects with their association status regarding a quality profile |
| POST | `/api/qualityprofiles/remove_project` | Remove a project's association with a quality profile. Requires one of the following permissions: 'Administer Quality... |
| POST | `/api/qualityprofiles/rename` | Rename a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the ... |
| POST | `/api/qualityprofiles/restore` | Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile... |
| POST | `/api/qualityprofiles/restore_built_in` | This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are... |
| GET | `/api/qualityprofiles/search` | Search quality profiles |
| POST | `/api/qualityprofiles/set_default` | Select the default profile for a given language. Requires to be logged in and the 'Administer Quality Profiles' permi... |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sonarsource/refs/heads/main/openapi/sonarsource-qualityprofiles-api-openapi.yml
- **APIReference** — https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/web-api/
- **Documentation** — https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/web-api/
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/sonarsource/refs/heads/main/data-model/sonarsource-data-model.yml

## Other SonarSource APIs (12)

- [SonarSource authentication API](https://apis.io/apis/sonarsource/sonarsource-authentication-api/)
- [SonarSource ce API](https://apis.io/apis/sonarsource/sonarsource-ce-api/)
- [SonarSource components API](https://apis.io/apis/sonarsource/sonarsource-components-api/)
- [SonarSource duplications API](https://apis.io/apis/sonarsource/sonarsource-duplications-api/)
- [SonarSource favorites API](https://apis.io/apis/sonarsource/sonarsource-favorites-api/)
- [SonarSource favourites API](https://apis.io/apis/sonarsource/sonarsource-favourites-api/)
- [SonarSource hotspots API](https://apis.io/apis/sonarsource/sonarsource-hotspots-api/)
- [SonarSource issues API](https://apis.io/apis/sonarsource/sonarsource-issues-api/)
- [SonarSource languages API](https://apis.io/apis/sonarsource/sonarsource-languages-api/)
- [SonarSource measures API](https://apis.io/apis/sonarsource/sonarsource-measures-api/)
- [SonarSource metrics API](https://apis.io/apis/sonarsource/sonarsource-metrics-api/)
- [SonarSource notifications API](https://apis.io/apis/sonarsource/sonarsource-notifications-api/)

## Tags

qualityprofiles

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sonarsource/sonarsource-qualityprofiles-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sonarsource/.
