# SonarSource qualitygates API

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

Manage quality gates, including conditions and project association.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/qualitygates/copy` | Copy a Quality Gate. Requires the 'Administer Quality Gates' permission. |
| POST | `/api/qualitygates/create` | Create a Quality Gate. Requires the 'Administer Quality Gates' permission. |
| POST | `/api/qualitygates/create_condition` | Add a new condition to a quality gate. Requires the 'Administer Quality Gates' permission. |
| POST | `/api/qualitygates/delete_condition` | Delete a condition from a quality gate. Requires the 'Administer Quality Gates' permission. |
| POST | `/api/qualitygates/deselect` | Remove the association of a project from a quality gate. Requires one of the following permissions:'Administer Qualit... |
| POST | `/api/qualitygates/destroy` | Delete a Quality Gate. Requires the 'Administer Quality Gates' permission. |
| GET | `/api/qualitygates/get_by_project` | Get the quality gate of a project. Requires one of the following permissions:'Administer' rights on the specified pro... |
| GET | `/api/qualitygates/list` | Get a list of quality gates |
| GET | `/api/qualitygates/project_status` | Get the quality gate status of a project or a Compute Engine task. Either 'analysisId', 'projectId' or 'projectKey' m... |
| POST | `/api/qualitygates/rename` | Rename a Quality Gate. Requires the 'Administer Quality Gates' permission. |
| GET | `/api/qualitygates/search` | Search for projects associated (or not) to a quality gate. Only authorized projects for current user will be returned. |
| POST | `/api/qualitygates/select` | Associate a project to a quality gate. The 'projectId' or 'projectKey' must be provided. Project id as a numeric valu... |
| POST | `/api/qualitygates/set_as_default` | Set a quality gate as the default quality gate. Requires the 'Administer Quality Gates' permission. |
| GET | `/api/qualitygates/show` | Display the details of a quality gate |
| POST | `/api/qualitygates/unset_default` | This webservice is no more available : a default quality gate is mandatory. |
| POST | `/api/qualitygates/update_condition` | Update a condition attached to a quality gate. Requires the 'Administer Quality Gates' permission. |

## Machine-readable artifacts (4)

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

Quality Gates

---

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