SonarQube API

Overview

Measurement Record

What actually happened when we called this API from our own infrastructure. Every value below was recorded by the request, not copied from the provider's documentation.

Request

GET https://sonarcloud.io/api/

Result

HTTP 200 · application/json · 209,730 bytes · compressed

Response time

920 ms (median of 3) · fastest 531 ms

Transport

TLSv1.3 · TLS_AES_128_GCM_SHA256

Browser CORS

Allowed — Access-Control-Allow-Origin: *

Recorded

2026-08-10

Fields Returned

Top-level fields present in the response we captured, with the type and value we actually received.

Captured Response

Captured from a real request to https://sonarcloud.io/api/ on 2026-08-10. Long arrays and nested objects are truncated to keep the shape readable.

{
  "webServices": [
    {
      "path": "api/authentication",
      "description": "Handle authentication.",
      "actions": [
        {
          "…": "(7 more fields)"
        }
      ]
    }
  ]
}

Implementation Example

Calls a real endpoint of this API. Replace any placeholder credentials with your own key.

const url = "https://sonarcloud.io/api/measures/component?component=YOUR_PROJECT_KEY&metricKeys=coverage,bugs,code_smells";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "Authorization": "Bearer YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

import requests

url = "https://sonarcloud.io/api/measures/component?component=YOUR_PROJECT_KEY&metricKeys=coverage,bugs,code_smells"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(url, headers=headers, timeout=30)
response.raise_for_status()
data = response.json()
print(data)

curl -u YOUR_TOKEN: "https://sonarcloud.io/api/measures/component?component=YOUR_PROJECT_KEY&metricKeys=coverage,bugs,code_smells"

What Can You Build?

// Get repository or project information
const headers = { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' };
const response = await fetch(`https://sonarcloud.io/web_api`, { headers });
const data = await response.json();
console.log('Project info:', data);
const info = data.repository || data;
console.log('Name:', info.name || info.full_name);
console.log('Stars:', info.stars || info.stargazers_count || 'N/A');

// Fetch developer resources
const headers = { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' };
const response = await fetch(`https://sonarcloud.io/web_api`, { headers });
const data = await response.json();
const items = Array.isArray(data) ? data : data.results || data.items || [data];
items.slice(0, 5).forEach(item => {
  console.log(`📦 ${item.name || item.title}: ${item.description || 'No description'}`);
});

// Search for development resources
const headers = { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' };
const query = 'javascript';
const response = await fetch(`https://sonarcloud.io/web_api`, { headers });
const data = await response.json();
const results = data.items || data.results || [];
results.slice(0, 5).forEach(r => {
  console.log(`Result: ${r.name || r.title} - ${r.url || r.html_url || ''}`);
});

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

How This API Fails

We deliberately sent this API a broken request and recorded exactly what came back on 2026-08-10. Knowing the shape of an error before you hit it makes error handling much easier to write.

{
  "errors": [
    {
      "msg": "Unknown url : /api/apisscore-nonexistent-path"
    }
  ]
}

Common Errors & Troubleshooting

Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.