Settings

General Settings

getSettingsGeneral

This function prints the objects data given its Settings General Object.

**Returns**
Parameter name	Type	Description
installed	Boolean	Value to determine if JetBackup 5 is installed.
debug	Boolean	Value to determine if Debug Mode is enabled.
error_reporting	Boolean	Value to determine if Error Reporting is enabled.
workspace_path	String	The absolute path to the set Workspace.
downloads_path	String	The absolute path to the store Downloads.
orphan_backup_ttl	Integer	Value to determine the TTL of Orphan Backups.
alerts_ttl	Integer	Value to determine the TTL of Alerts.
downloads_ttl	Integer	Value to determine the TTL of stored Downloads.
manually_backups_retain	Integer	Value to determine the retention of manual backups.
manually_backups_ttl	Integer	Value to determine the TTL of manual backups.

jetbackup5api -F getSettingsGeneral

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

manageSettingsGeneral

This function allows you to create/modify the Settings General Objects.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
debug	Boolean	Boolean value to determine if debug mode is enabled.	1 : true 0 : false	debug=0
error_reporting	Boolean	Boolean value to determine if error reporting is enabled.	1 : true 0 : false	error_reporting=0
workspace_path	String	The default path JetBackup uses for workspace.		workspace_path=/PATH/TO/WORKSPACE
downloads_path	String	The default path JetBackup uses to store downloads.		downloads_path=/usr/local/jetapps/usr/jetbackup5/downloads
orphan_backup_ttl	Integer	The maximum number of days to store an orphan backup.	Positive Integers (Default: 0 - disabled)	orphan_backup_ttl: 0
logs_ttl	Integer	Maximum number of days to keep logs.	Positive Integers (Default: 0 - disabled)	logs_ttl=5
alerts_ttl	Integer	The default path JetBackup uses to store downloads.	Positive Integers (Default: 0 - disabled)	alerts_ttl=90
downloads_ttl	Integer	Maximum number of days to keep Downloads.	Positive Integers (Default: 0 - disabled)	downloads_ttl=60
manually_backup_retain	Integer	Maximum number of Backup on Demands per account. (maximum 99)	1 - 99 (Default: 1)	manually_backup_retain=10
manually_backup_ttl	Integer	Maximum number of days to keep Manual Backups.	Positive Integers (Default: 0 - disabled)	manually_backup_ttl=15

jetbackup5api -F manageSettingsGeneral -D 'manually_backup_retain=10&manually_backup_ttl=15&debug=1'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsGeneral&manually_backup_retain=10&manually_backup_ttl=15&debug=1

Performance Settings

getSettingsPerformance

This function prints the objects data given its Settings Performance Object.

More Info

**Returns**
Parameter name	Type	Description
backup_forks	Integer	Number of Concurrent Backup Tasks set.
queueable_forks	Integer	Number of Concurrent Restore and Download Tasks set.
backup_fork_ttl	Integer	Value to determine the max run time of a single Backup Fork.
mysqldump_max_packet	Integer	The maximum packet length to send to or receive from server.
mysqldump_force	Boolean	Value to set MySQL Dump Force Flag.
mysqldump_opt	Boolean	Value to set MySQL Dump Opt Flag.
mysqldump_skip_lock	Boolean	Value to set MySQL Dump Skip Lock Table Flag.
directories_queue_priority	String	ID of the Priority Group Object enabled.
limit_account_downloads	Integer	Maximum numbeer of downloads a singe account can have.

jetbackup5api -F getSettingsPerformance

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

manageSettingsPerformance

This function allows you to create/modify the Settings Performance Object.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
backup_forks	Integer	Number of Concurrent Backup Tasks set.	Integers: 1 - 10 (Default: 1)	backup_forks=3
queueable_forks	Integer	Number of Concurrent Restore and Download Tasks set.	Integers: 1 - 10 (Default: 1)	queueable_forks=3
backup_fork_ttl	Integer	Value to determine the max run time (hours) of a single Backup Fork.	Positive Integers (Default: 0 - Disabled)	backup_fork_ttl=4
mysqldump_max_packet	Integer	The maximum packet length (MB) to send to or receive from server.	MySQL Default : 0 (Default) 32 MB : 32 64 MB : 64 128 MB : 128 256 MB : 256 512 MB : 512 1 GB : 1024	mysqldump_max_packet=512
mysqldump_force	Boolean	Value to set MySQL Dump Force Flag.	True : 1 (Default) False : 0	mysqldump_force=1
mysqldump_opt	Boolean	Value to set MySQL Dump Opt Flag.	True : 1 (Default) False : 0	mysqldump_opt=1
mysqldump_skip_lock	Boolean	Value to set MySQL Dump Skip Lock Table Flag.	True : 1 (Default) False : 0	mysqldump_skip_lock=1
directories_queue_priority	String	ID of the Priority Group Object enabled.	Priority Group Object ID	directories_queue_priority=60898bb2124408533d6be504
limit_account_downloads	Integer	Maximum numbeer of downloads a singe account can have.	Positive Integers (Default: 0 - Disabled)	limit_account_downloads=4

jetbackup5api -F manageSettingsPerformance -D 'backup_forks=5&limit_account_downloads=&'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSchedule&action=modify&_id=5f77b257272a784948143652&name=NEWNAME

Resource Settings

getSettingsResource

This function prints the objects data given its Settings Resource Object.

More Info

**Returns**
Parameter name	Type	Description
cpu_limit	Integer	The % limit you would like to set for CPU Usage.
io_read_limit	Integer	The limit MB/s you would like to set for IO Read Usage.
io_write_limit	Integer	The limit MB/s you would like to set for IO Write Usage.

jetbackup5api -F getSettingsResource

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

manageSettingsResource

This function allows you to create/modify the Settings Resource Object.

More Info

Parameter name	Type	Description	Possible Values
cpu_limit	Integer	The % limit you would like to set for CPU Usage.	Mininum: 5 Default: 0 (unlimited)
io_read_limit	Integer	The limit MB/s you would like to set for IO Read Usage.	Default: 0 (unlimited)
io_write_limit	Integer	The limit MB/s you would like to set for IO Write Usage.	Default: 0 (unlimited)

jetbackup5api -F manageSettingsResource

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

Restore Settings

Please see Restore Conditions and File Permissions for their specific API calls.

Security Settings

getSettingsSecurity

This function prints the objects data given its Settings Security Object..

More Info

**Returns**
Parameter name	Type	Description
plugin	String	Plugin ID of the Security Plugin Object enabled.
restore	Boolean	Boolean flag to determine whether or not to Restore the most recent "clean" backup after detection.
lock	Boolean	Boolean flag to determine whether or not to Lock the most recent "clean" backup after detection.

jetbackup5api -F getSettingsSecurity

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

manageSettingsSecurity

This function allows you to create/modify the Settings Security Object.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED on action modify. The ID of the schedule		5f890a19e55cf262863522f2
action	String	REQUIRED on both create/modify. The action you want to perform.	modify create	`'action=create'`
type	Integer	REQUIRED on action create. The integer value for Schedule Type.	Visit Schedule Types below for all possible values.	`'type=1'`
type_data[]*	List	REQUIRED on action create. For Schedule Types: Daily, Monthly	Visit Type Data below for all possible values.	`'type_data[]=1&type_data[]=2&...'`
	Integer	REQUIRED on action create. For Schedule Types: Hourly, Weekly	Visit Type Data below for all possible values.	`'type_data=1'`
	String	REQUIRED on action create. For Schedule Types: After Backup Job	id of the Backup Job you want to follow	`'type_data=5f864533cde674169f42ffe2'`

Returns

Returns standard API Response data.

jetbackup5api -F manageSchedule -D 'action=create&name=NEWNAME&type=2&type_data[]=1&type_data[]=2'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSchedule&action=modify&_id=5f77b257272a784948143652&name=NEWNAME

Privacy Settings

getSettingsPrivacy

This function prints the objects data given its Settings Privacy Object.

More Info

**Returns**
Parameter name	Type	Description
user_agreement	String	Custom User Agreement that will display on end user panel for approval.
privacy_policy	String	Custom Privacy Policy that will display on end user panel for approval.
encryption_selection	Boolean	Value to determine the user ability to select their Encryption Status.
forgotten_ttl	Integer	Value to determine the amount of days ALL account data will be kept after termination.

jetbackup5api -F getSettingsPrivacy

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

manageSettingsPrivacy

This function allows you to create/modify the Settings Privacy Object.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
user_agreement	String	Custom User Agreement that will display on end user panel for approval.		user_agreement=Are you sure
privacy_policy	String	Custom Privacy Policy that will display on end user panel for approval.		privacy_policy=Do you agree
encryption_selection	Boolean	Value to determine the user ability to select their Encryption Status.	False : 0 (default) True : 1	encryption_selection=1
forgotten_ttl	Integer	Value to determine the amount of days ALL account data will be kept after termination.	Positive integers. (Default: 0 - Disabled)	forgotten_ttl=30

jetbackup5api -F manageSettingsPrivacy -D "user_agreement=Are you sure&privacy_policy=Do you agree&encryption_selection=1&forgotten_ttl=30"

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsPrivacy&user_agreement=Are you sure&privacy_policy=Do you agree&encryption_selection=1&forgotten_ttl=30

Panel Settings

getSettingsPanel

This function prints the objects data given its Settings Panel Object.

More Info

**Panel Versions of JetBackup Returns**
Parameter name	Type	Description
default_owner	String	The default Owner you want to assign accounts after restores.
default_ip	String	The default IP you want to use for restores.
default_package	String	The default Package you want to use for restores.

**Paneless Versions of JetBackup Returns**
Parameter name	Type	Description
default_db_user	String	Account user name that will be assigned all databases by default.
assign_type	Integer	The manage databases plugin assign type. 1 = Automatic, 2 = Manual
mysql_enabled	Boolean	Value to determine if MySQL authentication is enabled.
mysql_user	String	Default MySQL user to use for authentication.
mysql_host	String	Default hostmane to use for MySQL authentication.
mysql_port	Integer	Default port to use for MySQL authentication
mysql_password	String	Password for your default MySQL user.
pg_enabled	Boolean	Value to determine if PostgreSQL authentication is enabled.
pg_user	String	Default PostgreSQL user to use for authentication.
pg_host	String	Default hostname to use for PostgreSQL authentication.
pg_port	Integer	Default port to use for PostgreSQL authentication
pg_password	String	Password for your default PostgreSQL user.
mongodb_enabled	Boolean	Value to determine if MongoDB authentication is enabled.
mongodb_user	String	Default MongoDB user to use for authentication.
mongodb_host	String	Default hostname to use for MongoDB authentication.
mongodb_port	Integer	Default port to use for MongoDB authentication
mongodb_password	String	Password for your default MySQL user.
mongodb_auth_db	String	The name of your MongoDB Authentication Database.

jetbackup5api -F getSettingsPanel

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

manageSettingsPanel

This function allows you to create/modify the Settings Panel Object.

More Info

**Panel Versions of JetBackup Returns**
Parameter name	Type	Description	Examples
default_owner	String	The default Owner you want to assign accounts after restores.	default_owner=root
default_ip	String	The default IP you want to use for restores.	default_ip=0.0.0.0
default_package	String	The default Package you want to use for restores.	default_package=default

**Paneless Versions of JetBackup Returns**
Parameter name	Type	Description
default_db_user	String	Account user name that will be assigned all databases by default.
mysql_enabled	Boolean	Value to determine if MySQL authentication is enabled.
mysql_user	String	Default MySQL user to use for authentication.
mysql_host	String	Default hostmane to use for MySQL authentication.
mysql_port	Integer	Default port to use for MySQL authentication
mysql_password	String	Password for your default MySQL user.
pg_enabled	Boolean	Value to determine if PostgreSQL authentication is enabled.
pg_user	String	Default PostgreSQL user to use for authentication.
pg_host	String	Default hostname to use for PostgreSQL authentication.
pg_port	Integer	Default port to use for PostgreSQL authentication
pg_password	String	Password for your default PostgreSQL user.
mongodb_enabled	Boolean	Value to determine if MongoDB authentication is enabled.
mongodb_user	String	Default MongoDB user to use for authentication.
mongodb_host	String	Default hostname to use for MongoDB authentication.
mongodb_port	Integer	Default port to use for MongoDB authentication
mongodb_password	String	Password for your default MySQL user.
mongodb_auth_db	String	The name of your MongoDB Authentication Database.

Returns

Returns standard API Response data.

jetbackup5api -F manageSettingsPanel -D 'default_owner=root&default_ip=0.0.0.0&default_package=default'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsPanel&default_owner=root&default_ip=0.0.0.0&default_package=default

API Access Tokens for Linux (Panelless) are managed via the PanelAPI function. Please see the PanelAPI documentation for API Access Tokens here.

Backup on Demand Settings

getSettingsSnapshots

This function prints the objects data given its Settings Snapshots Object.

More Info

**Returns**
Parameter name	Type	Description
backup	String	Backup Job ID of the Backup Job Object selected for Backup on Demand.
retain	Integer	Value to determine the retention of Backup on Demands for every account.
ttl	Integer	Value to determine the TTL of Backup on Demands for every account.

jetbackup5api -F getSettingsSnapshots

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

manageSettingsSnapshots

This function allows you to create/modify the Settings Snapshots Object.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
backup	String	Backup Job ID of the Backup Job Object selected for Backup on Demand.		backup=5f77b257272a784948143652
retain	Integer	Value to determine the retention of Backup on Demands for every account. (maximum 99)	1 - 99	retain=5
ttl	Integer	Value to determine the TTL of Backup on Demands for every account.	Positive Integers	ttl=3

jetbackup5api -F manageSettingsSnapshots -D "backup=5f77b257272a784948143652&retain=5&ttl=3"

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsSnapshots&backup=5f77b257272a784948143652&retain=5&ttl=3

Notification Settings

manageNotificationIntegration

This function allows you to create/modify the Notification Integration Object.

More Info

Parameter name Type Description Possible Values Example

action

String

REQUIRED Sets the flag to either create or modify your Notification Integration.

create
modify

'action=create'

_id String REQUIRED on action modify. The Notification Integration ID. N/A _id=648a03def62f62645905c2b2

type String The type of Notification Integration you will like to activate. Run listNotificationIntegrationTypes for a list of all available types. 'type=Email'

frequency

List []

Set the frequency of each Alert Level that you will like to receive.

Parameter (Alert Level)	Possible Values
frequency[1] (Information)	1 : Real Time 2 : Once a Day
frequency[2] (Warning)	1 : Real Time 2 : Once a Day
frequency[4] (Critical)	1 : Real Time 2 : Once a Day

'frequency[1]=1'

name String REQUIRED on action create. The name given to the Notification Integration for internal use. 'Admin Email'

options List [] Options are additional fields that can be set based on the Notification Integration Type. Please check each Notification Type Object for the fields you can configure. 'options[recipients][email protected]'

jetbackup5api -F manageNotificationIntegration -D "action=create&name=Admin Email&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients][email protected]"

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageNotificationIntegration&action=create&name=Admin%20Email&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients]=[email protected]

listNotificationIntegrationTypes

This function will list all available Notification Integration Types.

More Info

**Returns**
Parameter name	Type	Description
types	List []	A list of all Enabled Notification Plugins. Each type has a key, name, description, and version. Note the key/name is the Type used for manageNotificationIntegration.

jetbackup5api -F listNotificationIntegrationTypes

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

listNotificationIntegrations

This function will list all Enabled Notification Integration.

More Info

**Returns**
Parameter name	Type	Description
integrations	List []	A list of all Activated Notification Integrations.

jetbackup5api -F listNotificationIntegrations

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

getNotificationIntegration

This function will return the Enabled Notification Integration based on Type.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	The Notification Integration Object ID.	For a list of Notification Integrations, please use listNotificationIntegrations	_id=6169fde7916d0366563db4b2

jetbackup5api -F getNotificationIntegration -D "_id=6169fde7916d0366563db4b2"

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getNotificationIntegration&_id=6169fde7916d0366563db4b2

deleteNotificationIntegration

This function will delete the Enabled Notification Integration based on Type.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	The Notification Integration Object ID.	For a list of configured Notification Integrations, please use listNotificationIntegrations	_id=6169fde7916d0366563db4b2

jetbackup5api -F deleteNotificationIntegration -D "_id=6169fde7916d0366563db4b2"

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=deleteNotificationIntegration&_id=6169fde7916d0366563db4b2

Binary Settings

getSettingsBinary

This function prints the objects data given its Settings Binary Object.

More Info

**Returns**
Parameter name	Type	Description
rsync	String	Absolute path to the binary for rsync.
psql	String	Absolute path to the binary for psql.
pgrestore	String	Absolute path to the binary for pgrestore.
pgdump	String	Absolute path to the binary for pgdump.
mysql	String	Absolute path to the binary for mysql.
mysqldump	String	Absolute path to the binary for mysqldump.
ionice	String	Absolute path to the binary for ionice.
tar	String	Absolute path to the binary for tar.
gzip	String	Absolute path to the binary for gzip.
gunzip	String	Absolute path to the binary for gunzip.
mongodump	String	Absolute path to the binary for mongodump.
mongorestore	String	Absolute path to the binary for mongorestore.

jetbackup5api -F getSettingsBinary

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

manageSettingsBinary

This function allows you to create/modify the Settings Binary Object.

More Info

**Parameters**
Parameter name	Type	Description	Example
rsync	String	Absolute path to the binary for rsync.	rsync=/usr/local/jetapps/usr/bin/rsync
psql	String	Absolute path to the binary for psql.	psql=psql
pgrestore	String	Absolute path to the binary for pgrestore.	pgrestore=pg_restore
pgdump	String	Absolute path to the binary for pgdump.	pgdump=pg_dump
mysql	String	Absolute path to the binary for mysql.	mysql=mysql
mysqldump	String	Absolute path to the binary for mysqldump.	mysqldump=mysqldump
tar	String	Absolute path to the binary for tar.	tar=tar
gzip	String	Absolute path to the binary for gzip.	gzip=gzip
gunzip	String	Absolute path to the binary for gunzip.	gunzip=gunzip
mongodump	String	Absolute path to the binary for mongodump.	mongodump=/usr/local/jetapps/usr/bin/mongodump
mongorestore	String	Absolute path to the binary for mongorestore.	mongorestore=/usr/local/jetapps/usr/bin/mongorestore

jetbackup5api -F manageSettingsBinary -D 'gzip=/usr/bin/gzip'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsBinary&gzip=/usr/bin/gzip

JETAPI Documentation

On This Page:

General Settings

getSettingsGeneral

manageSettingsGeneral

Performance Settings

getSettingsPerformance

manageSettingsPerformance

Resource Settings

getSettingsResource

manageSettingsResource

Restore Settings

Security Settings

getSettingsSecurity

manageSettingsSecurity

Privacy Settings

getSettingsPrivacy

manageSettingsPrivacy

Panel Settings

getSettingsPanel

manageSettingsPanel

Backup on Demand Settings

getSettingsSnapshots

manageSettingsSnapshots

Notification Settings

manageNotificationIntegration

listNotificationIntegrationTypes

listNotificationIntegrations

getNotificationIntegration

deleteNotificationIntegration

Binary Settings

getSettingsBinary

manageSettingsBinary

On This Page: