WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.

NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

Plugin Object

This is the basic parameters for all plugins.

To view the parameters related to each plugin type click on Plugin type related parameters.

Parameter name	Type	Description	Example
_id	String	The ID of the plugin.	cxs
code	String	The identification code for the plugin.	cxs
name	String	The name for the plugin.	ConfigServer eXploit Scanner (cxs)
options	List	List of available options for each plugin type.

Plugin type related parameters

Security Plugin

CXS Options

Option name	Value	Description	Possible values	Example
actionScript	String	Path of a script that JetBackup will trigger once a security action is completed.		/Path/to/script.sh
watch	Boolean	Enable/Disable JetBackup hook point on CXS Watch.
ftp	Boolean	Enable/Disable JetBackup hook point on CXS FTP.
daily	Boolean	Enable/Disable JetBackup hook point on CXS Daily Cron.
cgi	Boolean	Enable/Disable JetBackup hook point on CXS CGI
flags	Integer	The action(s) JetBackup will execute once CXS triggers an infection alert.	No Actions: 0 Restore Infected File: 1 Lock Account Last Backup: 2 Both Actions: 3

Imunify360 Options

Option name	Value	Description	Possible values	Example
actionScript	String	Path of a script that JetBackup will trigger once a security action is completed.		/Path/to/script.sh
restoreFlag	Integer	Set at what point of detection JetBackup will execute a restore.	Never: 0 On malware detection: 1 On malware cleanup: 2
lockFlag	Integer	Set at what point of detection JetBackup will execute a backup lock.	Never: 0 On malware detection: 1 On malware cleanup: 2

WHM API Documentation

On This Page:

Plugin Object

On This Page: