Extension Management#
- REST API
- API Version: 7.1-preview
Prerequisites#
See QuickStart
Examples#
Now that we have the connection object webApi
, we can get the instance of ExtensionManagementApi
.
var extensions = webApi.getExtensionManagementApi();
We have access to the functionalities that Extension Management Api has.
Available functions#
Get an extension#
Get an extension with extension name and publisher id.
extensions.getExtension("sonarqube", "sonarsource");
Get a list of installed extensions#
Get a list of installed extensions.
extensions.getExtensions();
Install an extension#
Install an extension with extension name, publisher id and version. If version is null, latest version will be selected.
extensions.installExtension("sonarsource", "sonarqube", null);
Uninstall an extension#
Uninstall an extension with extension name and publisher id.
extensions.uninstallExtension("sonarsource", "sonarqube");
Update an extension#
You can enable and disable an extension with this API. If NONE is specified extension will be enabled.
extensions.updateExtension("sonarsource", "sonarqube", ExtensionStateFlags.DISABLED);
Note
You need administrator rights in organization level to manage the extensions. If you only have project level permission you can't install or uninstall an extension.