plugins.md

Plugins

plugins_controller = client.plugins

Class Name

PluginsController

Methods

• Disable Plugin
• Enable Plugin
• Get Plugin Configuration
• Get Plugin Image
• Get Plugin Manifest
• Get Plugins
• Uninstall Plugin
• Uninstall Plugin by Version
• Update Plugin Configuration

Disable Plugin

Disable a plugin.

def disable_plugin(self,
                  plugin_id,
                  version)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.
version	string	Template, Required	Plugin version.

Response Type

void

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'
version = 'version4'

result = plugins_controller.disable_plugin(plugin_id, version)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found.	ProblemDetailsException

Enable Plugin

Enables a disabled plugin.

def enable_plugin(self,
                 plugin_id,
                 version)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.
version	string	Template, Required	Plugin version.

Response Type

void

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'
version = 'version4'

result = plugins_controller.enable_plugin(plugin_id, version)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found.	ProblemDetailsException

Get Plugin Configuration

Gets plugin configuration.

def get_plugin_configuration(self,
                            plugin_id)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.

Response Type

object

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'

result = plugins_controller.get_plugin_configuration(plugin_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found or plugin configuration not found.	ProblemDetailsException

Get Plugin Image

Gets a plugin's image.

def get_plugin_image(self,
                    plugin_id,
                    version)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.
version	string	Template, Required	Plugin version.

Response Type

mixed

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'
version = 'version4'

result = plugins_controller.get_plugin_image(plugin_id, version)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Not Found	ProblemDetailsException

Get Plugin Manifest

Gets a plugin's manifest.

def get_plugin_manifest(self,
                       plugin_id)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.

Response Type

void

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'

result = plugins_controller.get_plugin_manifest(plugin_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found.	ProblemDetailsException

Get Plugins

Gets a list of currently installed plugins.

def get_plugins(self)

Response Type

List of PluginInfo

Example Usage

result = plugins_controller.get_plugins()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Uninstall Plugin

This endpoint is deprecated.

Uninstalls a plugin.

def uninstall_plugin(self,
                    plugin_id)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.

Response Type

void

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'

result = plugins_controller.uninstall_plugin(plugin_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found.	ProblemDetailsException

Uninstall Plugin by Version

Uninstalls a plugin by version.

def uninstall_plugin_by_version(self,
                               plugin_id,
                               version)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.
version	string	Template, Required	Plugin version.

Response Type

void

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'
version = 'version4'

result = plugins_controller.uninstall_plugin_by_version(plugin_id, version)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found.	ProblemDetailsException

Update Plugin Configuration

Accepts plugin configuration as JSON body.

def update_plugin_configuration(self,
                               plugin_id)

Parameters

Parameter	Type	Tags	Description
plugin_id	uuid|string	Template, Required	Plugin id.

Response Type

void

Example Usage

plugin_id = '00000c42-0000-0000-0000-000000000000'

result = plugins_controller.update_plugin_configuration(plugin_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Plugin not found or plugin does not have configuration.	ProblemDetailsException