API deprecation

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

If you use custom plugins based on the Plugin basics or consume SonarQube 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 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 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.