How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SonarSource qualityprofiles API

Manage quality profiles.

SonarSource qualityprofiles API is one of 33 APIs that SonarSource publishes on the 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.

This API exposes 22 operations across 22 paths. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://sonarcloud.io.

22 operations 22 paths 0 schemas 8 GET14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://sonarcloud.io/api
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

SonarSource qualityprofiles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). It accepts HTTP basic authentication (basicToken). By default, every request must be authenticated.

  • bearerToken — User token as Bearer token.
  • basicToken — User token as HTTP Basic username with empty password.

Paths & Operations 22

Across 22 paths, the API surfaces 22 operations — 8 GET, 14 POST. Each is listed below with its method, path, parameters, and response codes.

qualityprofiles 22

Manage quality profiles.

POST
/api/qualityprofiles/activate_rule
Activate a rule on a Quality Profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit r...
qualityprofilesActivateRule 5 params → 200400401403404
POST
/api/qualityprofiles/activate_rules
Bulk-activate rules on one quality profile. Requires one of the following permissions: 'Administer Quality Profiles' ...
qualityprofilesActivateRules 28 params → 200400401403404
POST
/api/qualityprofiles/add_project
Associate a project with a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' ...
qualityprofilesAddProject 6 params → 200400401403404
GET
/api/qualityprofiles/backup
Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.
qualityprofilesBackup 4 params → 200400401403404
POST
/api/qualityprofiles/change_parent
Change a quality profile's parent. Requires one of the following permissions: 'Administer Quality Profiles' Edit righ...
qualityprofilesChangeParent 6 params → 200400401403404
GET
/api/qualityprofiles/changelog
Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events ...
qualityprofilesChangelog 8 params → 200400401403404
POST
/api/qualityprofiles/copy
Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission.
qualityprofilesCopy 2 params → 200400401403404
POST
/api/qualityprofiles/create
Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission.
qualityprofilesCreate 3 params → 200400401403404
POST
/api/qualityprofiles/deactivate_rule
Deactivate a rule on a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit...
qualityprofilesDeactivateRule 2 params → 200400401403404
POST
/api/qualityprofiles/deactivate_rules
Bulk deactivate rules on Quality profiles. Requires one of the following permissions: 'Administer Quality Profiles' E...
qualityprofilesDeactivateRules 28 params → 200400401403404
POST
/api/qualityprofiles/delete
Delete a quality profile and all its descendants. The default quality profile cannot be deleted. Requires one of the ...
qualityprofilesDelete 4 params → 200400401403404
GET
/api/qualityprofiles/exportdeprecated
Deprecated. Use GET /api/qualityprofiles/backup instead
qualityprofilesExport 4 params → 200400401403404
GET
/api/qualityprofiles/exportersdeprecated
Deprecated. No more custom profile exporters.
qualityprofilesExporters → 200400401403404
GET
/api/qualityprofiles/importersdeprecated
Deprecated. No more custom profile importers.
qualityprofilesImporters → 200400401403404
GET
/api/qualityprofiles/inheritance
Show a quality profile's ancestors and children.
qualityprofilesInheritance 4 params → 200400401403404
GET
/api/qualityprofiles/projects
List projects with their association status regarding a quality profile
qualityprofilesProjects 5 params → 200400401403404
POST
/api/qualityprofiles/remove_project
Remove a project's association with a quality profile. Requires one of the following permissions: 'Administer Quality...
qualityprofilesRemoveProject 6 params → 200400401403404
POST
/api/qualityprofiles/rename
Rename a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the ...
qualityprofilesRename 2 params → 200400401403404
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...
qualityprofilesRestore 2 params → 200400401403404
POST
/api/qualityprofiles/restore_built_indeprecated
This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are...
qualityprofilesRestoreBuiltIn → 200400401403404
GET
/api/qualityprofiles/search
Search quality profiles
qualityprofilesSearch 5 params → 200400401403404
POST
/api/qualityprofiles/set_default
Select the default profile for a given language. Requires to be logged in and the 'Administer Quality Profiles' permi...
qualityprofilesSetDefault 4 params → 200400401403404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonarsource-qualityprofiles-api-openapi.yml Raw ↑

Other APIs SonarSource publishes across the network.

SonarSource authentication API
SonarSource ce API
SonarSource components API
SonarSource duplications API
SonarSource favorites API
SonarSource favourites API
SonarSource hotspots API
SonarSource issues API
SonarSource languages API
SonarSource measures API
SonarSource metrics API
SonarSource notifications API
Where this information came from

This is an independent, third-party profile of SonarSource qualityprofiles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.