# SonarSource rules API

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

Get and update some details of automatic rules, and manage custom rules.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/rules/repositories` | List available rule repositories |
| GET | `/api/rules/search` | Search for a collection of relevant rules matching a specified query. Since 5.5, following fields in the response hav... |
| GET | `/api/rules/show` | Get detailed information about a rule Since 5.5, following fields in the response have been deprecated :"effortToFixD... |
| GET | `/api/rules/tags` | List rule tags |
| POST | `/api/rules/update` | Update an existing rule. Requires the 'Administer Quality Profiles' permission |

## Machine-readable artifacts (4)

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

Rules

---

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