canonical: https://jentic.com/apis/sonarcloud.io/sonarcloud

# Sonarcloud SonarQube Web API

SonarQube/SonarCloud Web API for code quality and security analysis management. Provides endpoints for managing projects, issues, quality gates, quality profiles, rules, measures, and more. The API exposes 156 endpoints secured with basic, bearer authentication.

## For AI agents

Programmatically logout a user., check credentials. returns true for anonymous user.. Covers 156 operations with basic, bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for social media only.

## Capabilities

- Logout a user.
- Check credentials. Returns true for anonymous user.
- Search for tasks.<br> Either componentId or component can be provided, but not b
- Returns CE activity related metrics.<br>Requires 'Administer' permission on the
- Get the pending tasks, in-progress tasks and the last executed task of a given c
- Give Compute Engine task details such as type, status, duration and associated c

## Use cases

### Social Media Operations

Use the SonarQube Web API to perform social media operations programmatically. The API provides 156 endpoints covering core functionality including logout a user., check credentials. returns true for anonymous user., search for tasks.<br> either componentid or component can be provided, but not b.

Example prompt: Call POST /authentication/logout to logout a user.

### Automated authentication Management

Automate authentication operations by combining multiple SonarQube Web API endpoints. Agents can check credentials. returns true for anonymous user. and then search for tasks.<br> either componentid or component can be provided, but not b in a single workflow.

Example prompt: Call GET /authentication/validate to check credentials. returns true for anonymous user., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SonarQube Web API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic, bearer tokens manually.

Example prompt: Search Jentic for 'logout a user.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /authentication/logout | Logout a user. |
| GET | /authentication/validate | Check credentials. Returns true for anonymous user. |
| GET | /ce/activity | Search for tasks.<br> Either componentId or component can be provided, but not b |
| GET | /ce/activity_status | Returns CE activity related metrics.<br>Requires 'Administer' permission on the |
| GET | /ce/component | Get the pending tasks, in-progress tasks and the last executed task of a given c |
| GET | /ce/task | Give Compute Engine task details such as type, status, duration and associated c |
| GET | /components/search | Search for projects. Used to provide the ability to search for any component but |
| GET | /components/show | Returns a component (file, directory, project) and its ancestors. The ancestors |

## Key resources

- **authentication** — Handle authentication.
- **ce** — Get information on Compute Engine tasks.
- **components** — Get information about a component (file, directory, project, ...) and its ancestors or descendants.
- **duplications** — Get duplication information for a project.
- **favorites** — Manage user favorites

## Why Jentic

- **Setup:** Wiring the SonarQube Web API by hand means choosing between basic and bearer token auth, pointing at the sonarcloud.io/api host, and handling paging and retries across its analysis and component endpoints yourself. Through Jentic you install once, import the SonarQube Web API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The SonarQube Web API targets projects and components through query parameters rather than resource ids in the URL path, so scope the agent to the operations it needs, such as searching components or reading compute engine activity. You choose the operations it may call, so state-changing ones like logging a user out are not included unless you add them.
- **Credential handling:** Your SonarQube token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'search components' or 'check analysis task status', and Jentic returns the matching SonarQube Web API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Facebook** — Alternative social media API
- **Twitter** — Alternative social media API
- **Linkedin** — Complementary social media API

## FAQ

### What authentication does the SonarQube Web API use?

The SonarQube Web API uses basic, bearer authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I logout a user. with the SonarQube Web API?

Yes. Use the POST /authentication/logout endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SonarQube Web API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I logout a user. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'logout a user.'. Jentic returns the matching SonarQube Web API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SonarQube Web API have?

The SonarQube Web API exposes 156 endpoints covering authentication, ce, components operations.

### Can I limit what my agent is allowed to do with the SonarQube Web API?

Yes. Jentic One is self-hosted, so your own rules decide which SonarQube Web API operations and credentials the agent may use. Because this API targets projects and components through query parameters rather than resource ids in the URL path, you scope the agent to just the operations it needs, such as searching components or reading compute engine activity. State-changing operations like logging a user out are excluded unless you explicitly add them.