Plugins

listPlugins

This function returns a list of installed Plugins.


listPackages

This function returns a list of available Plugin packages from Repositories.


getPlugin

This function returns the Plugin details.

managePlugin

This function lets you manage and enable Plugins.

installPlugin

This function allows you to install a Plugin given its package id or zip file.


uninstallPlugin

This function allows you to uninstall the Plugin given it's Plugin ID.


updatePlugin

This function manually updates an installed plugin.


listAvailablePlugins

This function returns a list of compressed plugin files that are downloaded and available to install.


manageSecurityPlugin

This function enables or disables the Imunify360 Security Plugin. If no data is passed to the manageSecurityPlugin API call, the plugin is disabled.


Parameter Dictionary

Plugin Object

Plugin Object
Parameter name Type Description Examples
_id String ID of the Plugin. 60903b9f6913fc54281a01
code String Short name for the Plugin. S3
name String The name of the Plugin. S3 Compatible
description String Description of the Plugin. Generic S3 compatible destination
icon String Icon data. N/A
type String Type of Plugin security, notification
version Integer Plugin release version. 1.0.0
author String Author of the Plugin JetApps
experimental Boolean True if plugin is experimental. 1
repo string Repository ID 608b1c707cf97c14601472e2
repo_name String Repository Name JetApps Repository
package_md5sum String md5 checksum for the plugin package. 88cccac198f703042502797781b
package_url String Package Zip File jetbackup-plugin-notification-telegram-1.0.0.zip
created String Date-Time the Plugin was fetched from the Repo. 2021-05-07T18:40:48+00:00
plugin List [] A list of corresponding data associated with an installed Plugin Ojbect.
  • _id (string)
  • code (string)
  • name (string)
  • description (string)
  • version (integer)
  • type (string)
  • author (string)
  • permissions (integer)
  • experimental (boolean)
  • repo (string)
  • options (List [])
  • repo_name (string)
  • disabled (boolean)
  • visible (boolean)
  • available_package (string)
plugin_id String ID of the Plugin in JetBackup. 60903b9f6913fc54281a01f2
installed Boolean True if plugin is installed. 1
installable Boolean True if plugin can be installed. 1
disabled Boolean True if plugin is disabled. 0
options List [] Array of Plugin options or settings. N/A
available_package Boolean True if plugin is disabled. 0