You are viewing an old version of this page. View the current version.
Compare with Current ·
View Page History
| Table of Contents |
Get Coding Rules Activated in a Quality Profile
| Description | Get the list of coding rules activated in a quality profile |
URL | /api/profiles |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | None |
Examples
| Use Case | Example Request |
|---|---|
| Get all the coding rules activated on the default java quality profile | |
| Get all the coding rules activated on the java quality profile 'Common rules' |
|
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
language | Project language | Yes | None | java |
name | Profile name. If not set, the default profile for the selected language is used. | No | None | Sonar%20way |
rule_repositories | Comma-separated list of rules repository keys. | No | None | pmd,findbugs |
rule_severities | Comma-separated list of rule severities. | No | None | BLOCKER,CRITICAL |
| format | Response formats. Possible values: xml | json | No | None | json |
Backup a Quality Profile
| Description | Backup a quality profile |
URL | /api/profiles/backup |
| HTTP Method | GET |
| Response Formats | json | xml |
| Security | Requires Global Administrator role |
| Available since | Sonar 3.1 |
Examples
| Use Case | Example Request |
|---|---|
| Backup the default java quality profile | |
| Backup the java quality profile 'Sonar%20way' |
|
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
language | Project language | Yes | None | java |
name | Profile name. If not set, the default profile for the selected language is used. | No | None | Sonar%20way |
| format | Response formats. | No | None | json |
Restore a Quality Profile Backup
| Description | Restore a quality profile backup |
URL | /api/profiles/restore |
| HTTP Method | POST |
| Security | Requires Global Administrator role |
| Available since | Sonar 3.1 |
Examples
| Use Case | Example Request |
|---|---|
| Restore a quality profile from a backup |
|
Parameters
Parameter | Description | Required |
|---|---|---|
backup | Path to the file containing the backup (HTML format) | Yes |
Labels
