# SonarSource components API

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

Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key.

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/components/search` | Search for projects. Used to provide the ability to search for any component but this option has been removed and web... |
| GET | `/api/components/show` | Returns a component (file, directory, project) and its ancestors. The ancestors are ordered from the parent to the ro... |
| GET | `/api/components/tree` | Navigate through components based on the chosen strategy. Requires the following permission: 'Browse' on the specifie... |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sonarsource/refs/heads/main/openapi/sonarsource-components-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 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/)
- [SonarSource permissions API](https://apis.io/apis/sonarsource/sonarsource-permissions-api/)

## Tags

Components

---

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