Monitoring the deprecated API components
If you use custom plugins based on the plugin API or consume SonarQube services through the Web API then you will have to manage the possible API deprecations. See also the Web API deprecation policy and the Plugin API deprecation policy.
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):
- In the top navigation bar of the SonarQube UI, select Administration > System.
- 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.
Was this page helpful?
© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARQUBE, and CLEAN AS YOU CODE are trademarks of SonarSource SA.
