> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/sonarqube-server/9.9/extension-guide/web-api.md).
# Web API
SonarQube 9.9 provides web API to access its functionalities from applications.
{% hint style="info" %}
**For AI agents:** You're in the SonarQube Server 9.9 documentation. For a list of all 9.9 pages, see the [SonarQube Server 9.9 page index](https://152261287-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBmptmznn7RpPe5u7vdup%2Fuploads%2F7O6jgZAiehDGe0FMXDaC%2Fsonarqube-server-9.9-llms.txt?alt=media). For the whole site, see the [page index](https://docs.sonarsource.com/llms.txt) or the [full text](https://docs.sonarsource.com/llms-full.txt). For another version, replace 9.9 in the URL with that version. The [latest version](https://docs.sonarsource.com/sonarqube-server/) has no version number in its URL.
{% endhint %}
## Documentation
SonarQube provides web API to access its functionalities from applications. The web services composing the web API are documented within SonarQube, by URL. You can also access the web API documentation from the top bar in SonarQube:
{% hint style="warning" %}
It’s highly recommended to use form data parameters when making POST requests to the Web API. If you use URI query parameters instead then these parameters won’t be securely passed to the endpoint.
{% endhint %}
## Authentication
Administrative web services are secured and require the user to have specific permissions. In order to be authenticated, the user must provide credentials as described below.
### User Token
This is the recommended way. Benefits are described on the page [Generating and using tokens](/sonarqube-server/9.9/user-guide/user-account/generating-and-using-tokens.md). The token is sent via the login field of HTTP basic authentication, without any password.
```css-79elbk
# note that the colon after the token is required in curl to set an empty password
curl -u THIS_IS_MY_TOKEN: https://sonarqube.com/api/user_tokens/search
```
### HTTP Basic Access
Login and password are sent via the standard HTTP Basic fields:
```css-79elbk
curl -u MY_LOGIN:MY_PASSWORD https://sonarqube.com/api/user_tokens/search
```
Users who authenticate in the web application through an OAuth provider, for instance, GitHub or Bitbucket, don’t have credentials and can’t use HTTP Basic mode. They must generate and use tokens.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.sonarsource.com/sonarqube-server/9.9/extension-guide/web-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
