This version of SonarQube Server is no longer receiving patches. Please see the latest release for details on updating.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API deprecation

If you use custom plugins based on the plugin API or consume SonarQube Server 10.5 services, you should monitor the deprecation of the APIs.

For AI agents: You're in the SonarQube Server 10.5 documentation. SonarQube Server 10.5 is no longer patched. To get patches, upgrade to the latest version. For a list of all 10.5 pages, see the SonarQube Server 10.5 page index. For the whole site, see the page index or the full text. For another version, replace 10.5 in the URL with that version. The latest version has no version number in its URL.

If you use custom plugins based on the Plugin basics or consume SonarQube Server services through the Web API then you will have to manage the possible API deprecations. See also the Web API and the Plugin basics.

Monitoring the deprecated Web API components

After an upgrade, you can check if an authenticated client of your SonarQube Server instance uses deprecated Web API endpoints and parameters in order to anticipate their drop. To do so, browse the deprecation log as illustrated below.

To download the deprecation log from the UI (with the Administer System permission):

  1. In the top navigation bar of the SonarQube Server UI, select Administration > System.

  2. In the top right corner of the System Info page, click Download Logs > Deprecation Logs.

You can automate the retrieval of the deprecation log information by calling the Web API endpoint api/system/logs with deprecation as the value of the name parameter.

Monitoring the deprecated Plugin API components

Check the Plugin API release notes for deprecation notes.

Last updated

Was this helpful?