# SonarSource settings API

**Canonical:** https://apis.io/apis/sonarsource/sonarsource-settings-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 settings 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 Settings. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

Manage settings.

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/settings/list_definitions` | List settings definitions. Requires 'Browse' permission when a component is specified To access licensed settings, au... |
| POST | `/api/settings/reset` | Remove a setting value. The settings defined in conf/sonar.properties are read-only and can't be changed. Requires th... |
| POST | `/api/settings/set` | Update a setting value. Either 'value' or 'values' must be provided. The settings defined in conf/sonar.properties ar... |
| GET | `/api/settings/values` | List settings values. If no value has been set for a setting, then the default value is returned. Both component and ... |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sonarsource/refs/heads/main/openapi/sonarsource-settings-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

Settings

---

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