| Info | ||||
|---|---|---|---|---|
| ||||
|
Get a List of Profiles
| Description | Get a list of profiles |
URL | /api/profiles/list |
| HTTP Method | GET |
| Response Formats | json |
Security | None |
| Available since | Sonar 3.3 |
Examples
Use Case | Example Request |
|---|---|
Get all the profiles | |
| Get all the java profiles |
|
| Get all the profiles used by project org.codehaus.sonar:sonar |
|
| Get the java profile used by project org.codehaus.sonar:sonar |
|
Response Format
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"name":"Sonar way with Findbugs",
"language":"java",
"default":false
},
{
"name":"Sonar way",
"language":"java",
"default":false
},
...
] |
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
language | Profile language | No | None | java |
project | Project key or id | No | None | org.codehaus.sonar:sonar |
| format | Response formats.Possible values: json format can be set through:
If nothing is set, json is used. | No | None | json |
Get Coding Rules Activated in a Quality Profile
...
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 format can be set through:
If nothing is set, json is used. | No | None | json |
Backup a Quality Profile
...
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.
If nothing is set, json is used. | No | None | json |
Restore a Quality Profile Backup
...
| Use Case | Example Request |
|---|---|
| Delete the java quality profile Sonar%way'Sonar way' |
|
...
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
language | Profile language | Yes | None | java |
| name | Profile name | Yes | None | Sonar way |
Set a Quality Profile as Default
| Description | Delete a quality profile |
URL | /api/profiles/set_as_default |
| HTTP Method | POST |
| Security | Requires Global Administrator role |
| Available since | Sonar 3.3 |
Examples
| Use Case | Example Request |
|---|---|
| Set the java quality profile 'Sonar way' as default |
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
language | Profile language | Yes | None | java |
| name | Profile name | Yes | None | Sonar way |
