Plugins

listPlugins

This function returns a list of installed Plugins.

Parameters

Parameter name	Type	Description	Possible values	Example
filter	String	Filter installed plugins by name or description.		filter=SSH

To view available listing parameters, please visit List Parameters.

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of installed plugin items. To view the parameters returned by this function, click on Plugin Item Object.

total Integer The total number of Installed Plugin Items

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of installed plugin items.	To view the parameters returned by this function, click on Plugin Item Object.
total	Integer	The total number of Installed Plugin Items

jetbackup5api -F listPlugins -D 'filter=SSH'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listPlugins&filter=SSH

listPackages

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

More Info

Parameters

Parameter name Type Description Possible values Example

filter String Filter packages by name or description. filter=Google Hangouts

find List [] Find packages by name, type, repo ID, or code. find[name]=Slack&find[type]=notification

To view available listing parameters, please visit List Parameters.

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of all Plugin packages. To view the parameters returned by this function, click on Plugin Item Object.

total Integer The total number of Package Items

JETAPI

HTTP
jetbackup5api -F listPackages -D 'find[type]=notification'
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listPackages&find[type]=notification

Parameter name	Type	Description	Possible values	Example
filter	String	Filter packages by name or description.		`filter=Google Hangouts`
find	List []	Find packages by name, type, repo ID, or code.		`find[name]=Slack&find[type]=notification`

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of all Plugin packages.	To view the parameters returned by this function, click on Plugin Item Object.
total	Integer	The total number of Package Items

listRepositories

This function returns a list of available Repositories.

More Info

Parameters

Parameter name Type Description Possible values Example

filter String Filter repositories by name or description. filter=JetApps Repository

To view available listing parameters, please visit List Parameters.

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of all repositories.

JETAPI

HTTP
jetbackup5api -F listRepositories -D 'filter=JetApps Repository'
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listRepositories&filter='JetApps Repository'

Parameter name	Type	Description	Possible values	Example
filter	String	Filter repositories by name or description.		`filter=JetApps Repository`

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of all repositories.

getPlugin

This function returns the Plugin details.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`

To view available listing parameters, please visit List Parameters.

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of data for the Plugin Object. To view the parameters returned by this function, click on Plugin Item Object.

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of data for the Plugin Object.	To view the parameters returned by this function, click on Plugin Item Object.

jetbackup5api -F getPlugin -D '_id=609afe0dcd7df74d5b4b2072'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getPlugin&_id=609afe0dcd7df74d5b4b2072

managePlugin

This function lets you manage and enable Plugins.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`
disabled	Boolean	True if disabled.		1
repo	string	Set or Change the Repository by Repo ID.		`repo=608b1c707cf97c14601472e2`
visible	Boolean	JetBackup Linux Only True if visiblility enabled in JetBackup Panel.		1
permissions	Integer	JetBackup Linux Only The Plugin permission value (may vary by Plugin).	1 (Root Access) 3 (Root & Reseller Access) 7 (Root, Reseller & User Access)

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of data for the Plugin Object. To view the parameters returned by this function, click on Plugin Item Object.

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of data for the Plugin Object.	To view the parameters returned by this function, click on Plugin Item Object.

jetbackup5api -F managePlugin -D '_id=609afe0dcd7df74d5b4b2072&disabled=0'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=managePlugin&_id=609afe0dcd7df74d5b4b2072&disabled=0

installPlugin

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

More Info

Parameters

Parameter name	Type	Description	Example
package_id	String	REQUIRED The Plugin ID.	`package_id=608b1c5f160247613b11dc02`
package_name	String	The compressed package file.	`package_name=607ed9abc2bea96e77403c21.zip`
disabled	Boolean	Set to false to enable the plugin. Disabled by default.	`disabled=0`

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of data for the Plugin Object. To view the parameters returned by this function, click on Plugin Item Object.

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of data for the Plugin Object.	To view the parameters returned by this function, click on Plugin Item Object.

jetbackup5api -F installPlugin -D 'package_id=608b1c5f160247613b11dc02'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=installPlugin&package_id=608b1c5f160247613b11dc02

uninstallPlugin

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

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`

Returns

Returns standard API Response data.

jetbackup5api -F uninstallPlugin -D '_id=608b1c5f160247613b11dc02'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=uninstallPlugin&_id=608b1c5f160247613b11dc02

updatePlugin

This function manually updates an installed plugin.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of data for the Plugin Object. To view the parameters returned by this function, click on Plugin Item Object.

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of data for the Plugin Object.	To view the parameters returned by this function, click on Plugin Item Object.

jetbackup5api -F updatePlugin -D '_id=608b1c5f160247613b11dc02'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=updatePlugin&_id=608b1c5f160247613b11dc02

listAvailablePlugins

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

More Info

Parameters

Parameter name Type Description Possible values Example

filter String Filter plugins by name or description. filter=SSH

Parameter name	Type	Description	Possible values	Example
filter	String	Filter plugins by name or description.		filter=SSH

Returns

Parameter name Type Description Possible values Example

data List [] Returns an array of compressed plugin ID's. 0: 607ed9abc2bea96e77403c21.zip

total Integer The total number of Installed Plugin Items

Parameter name	Type	Description	Possible values	Example
data	List []	Returns an array of compressed plugin ID's.		`0: 607ed9abc2bea96e77403c21.zip`
total	Integer	The total number of Installed Plugin Items

jetbackup5api -F listAvailablePlugins

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAvailablePlugins

manageSecurityPlugin

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

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
plugin	String	REQUIRED The Security Plugin ID.		`plugin=6095b151ae9021718f3c75022`
lock	Boolean	Boolean flag to determine whether or not to Lock the most recent "clean" backup after detection.	0 (false) 1 (true)	`lock=1`
restore	Boolean	Boolean flag to determine whether or not to Restore the most recent "clean" backup after detection.	0 (false) 1 (true)	`restore=1`

Returns

Returns standard API Response data.

jetbackup5api -F manageSecurityPlugin -D 'plugin=609afe0dcd7df74d5b4b2072&lock=0&restore=1'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSecurityPlugin&plugin=609afe0dcd7df74d5b4b2072&lock=0&restore=1

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

JETAPI Documentation

On This Page:

Plugins

listPlugins

listPackages

listRepositories

getPlugin

managePlugin

installPlugin

uninstallPlugin

updatePlugin

listAvailablePlugins

manageSecurityPlugin

Parameter Dictionary

Plugin Object

On This Page: