Module plugins_api

Enums

DisablePluginError

struct for typed errors of method disable_plugin

EnablePluginError

struct for typed errors of method enable_plugin

GetMarketplacePluginsError

struct for typed errors of method get_marketplace_plugins

GetMarketplaceVisitedByAdminError

struct for typed errors of method get_marketplace_visited_by_admin

GetPluginStatusesError

struct for typed errors of method get_plugin_statuses

GetPluginsError

struct for typed errors of method get_plugins

GetWebappPluginsError

struct for typed errors of method get_webapp_plugins

InstallMarketplacePluginError

struct for typed errors of method install_marketplace_plugin

InstallPluginFromUrlError

struct for typed errors of method install_plugin_from_url

RemovePluginError

struct for typed errors of method remove_plugin

UploadPluginError

struct for typed errors of method upload_plugin

Functions

disable_plugin

Disable a previously enabled plugin. Plugins must be enabled in the server’s config settings. ##### Permissions Must have manage_system permission. Minimum server version: 4.4

enable_plugin

Enable a previously uploaded plugin. Plugins must be enabled in the server’s config settings. ##### Permissions Must have manage_system permission. Minimum server version: 4.4

get_marketplace_plugins

Gets all plugins from the marketplace server, merging data from locally installed plugins as well as prepackaged plugins shipped with the server. ##### Permissions Must have manage_system permission. Minimum server version: 5.16

get_marketplace_visited_by_admin

Retrieves the status that specifies that at least one System Admin has visited the in-product Plugin Marketplace. Minimum server version: 5.33 ##### Permissions Must have manage_system permissions.

get_plugin_statuses

Returns the status for plugins installed anywhere in the cluster ##### Permissions No permissions required. Minimum server version: 4.4

get_plugins

Get a list of inactive and a list of active plugin manifests. Plugins must be enabled in the server’s config settings. ##### Permissions Must have manage_system permission. Minimum server version: 4.4

get_webapp_plugins

Get a list of web app plugins installed and activated on the server. ##### Permissions No permissions required. Minimum server version: 4.4

install_marketplace_plugin

Installs a plugin listed in the marketplace server. ##### Permissions Must have manage_system permission. Minimum server version: 5.16

install_plugin_from_url

Supply a URL to a plugin compressed in a .tar.gz file. Plugins must be enabled in the server’s config settings. ##### Permissions Must have manage_system permission. Minimum server version: 5.14

remove_plugin

Remove the plugin with the provided ID from the server. All plugin files are deleted. Plugins must be enabled in the server’s config settings. ##### Permissions Must have manage_system permission. Minimum server version: 4.4

upload_plugin

Upload a plugin that is contained within a compressed .tar.gz file. Plugins and plugin uploads must be enabled in the server’s config settings. ##### Permissions Must have manage_system permission. Minimum server version: 4.4