Plugins

class matterapi.endpoints.async_api.PluginsApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints related to uploading and managing plugins.

async disable_plugin(plugin_id: str) → matterapi.models.StatusOK

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
Api Reference:: DisablePlugin

async enable_plugin(plugin_id: str) → matterapi.models.StatusOK

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
Api Reference:: EnablePlugin

async get_marketplace_plugins(*, page: Optional[int] = None, per_page: Optional[int] = None, filter: Optional[str] = None, server_version: Optional[str] = None, local_only: Optional[bool] = None) → List[matterapi.models.MarketplacePlugin]

Gets all the 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
Api Reference:: GetMarketplacePlugins

async get_marketplace_visited_by_admin() → matterapi.models.System

Get if the Plugin Marketplace has been visited by at least an admin.

Retrieves the status that specifies that at least one System Admin has visited the in-product Plugin Marketplace.

Permissions:: Must have manage_system permissions.
Minimum Server Version:: 5.33
Api Reference:: GetMarketplaceVisitedByAdmin

async get_plugin_statuses() → List[matterapi.models.PluginStatus]

Get plugins status

Returns the status for plugins installed anywhere in the cluster

Permissions:: No permissions required.
Minimum Server Version:: 4.4
Api Reference:: GetPluginStatuses

async get_plugins() → matterapi.models.GetPluginsResponse200

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
Api Reference:: GetPlugins

async get_webapp_plugins() → List[matterapi.models.PluginManifestWebapp]

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
Api Reference:: GetWebappPlugins

async install_marketplace_plugin(*, json_body: Union[matterapi.models.InstallMarketplacePluginJsonBody, Dict]) → matterapi.models.PluginManifest

Installs a marketplace plugin

Installs a plugin listed in the marketplace server.

Permissions:: Must have manage_system permission.
Minimum Server Version:: 5.16
Api Reference:: InstallMarketplacePlugin

async install_plugin_from_url(*, plugin_download_url: str, force: Optional[str] = None) → matterapi.models.StatusOK

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
Api Reference:: InstallPluginFromUrl

async remove_plugin(plugin_id: str) → matterapi.models.StatusOK

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
Api Reference:: RemovePlugin

async upload_plugin(*, multipart_data: Union[matterapi.models.UploadPluginMultipartData, Dict]) → matterapi.models.StatusOK

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
Api Reference:: UploadPlugin