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.

Example Call JETAPI

jetbackup5api -F getSettingsGeneral

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  installed: 1
  debug: 0
  error_reporting: 1
  workspace_path: /usr/local/jetapps/usr/jetbackup5/workspace
  downloads_path: /usr/local/jetapps/usr/jetbackup5/downloads
  orphan_backup_ttl: 180
  logs_ttl: 30
  alerts_ttl: 60
  downloads_ttl: 0
  manually_backup_retain: 14
  manually_backup_ttl: 0
  use_community_languages: 1
  email_integration: 65075381a8f98c6ea7022b64
  time_format: 12

Example Call HTTP

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`

Example Call JETAPI

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

success: 1
message: General Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  installed: 1
  debug: 1
  error_reporting: 1
  workspace_path: /usr/local/jetapps/usr/jetbackup5/workspace
  downloads_path: /usr/local/jetapps/usr/jetbackup5/downloads
  orphan_backup_ttl: 180
  logs_ttl: 30
  alerts_ttl: 60
  downloads_ttl: 0
  manually_backup_retain: 10
  manually_backup_ttl: 15
  use_community_languages: 1
  email_integration: 65075381a8f98c6ea7022b64
  time_format: 12

Example Call HTTP

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 number of downloads a single account can have.

backup_integrity_check_schedule Integer How often the backup cleanup and integrity check task should run (in Days).

**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 number of downloads a single account can have.
backup_integrity_check_schedule	Integer	How often the backup cleanup and integrity check task should run (in Days).

Example Call JETAPI

jetbackup5api -F getSettingsPerformance

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  backup_forks: 5
  queueable_forks: 5
  system_forks: 5
  backup_fork_ttl: 0
  mysqldump_max_packet: 0
  mysqldump_force: 1
  mysqldump_opt: 1
  mysqldump_skip_lock: 1
  mysqldump_multibyte: 1
  directories_queue_priority:
  limit_account_downloads: 0
  backup_integrity_check_schedule: 7

Example Call HTTP

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 number of downloads a single account can have.	Positive Integers (Default: 0 - Disabled)	`limit_account_downloads=4`
backup_integrity_check_schedule	Integer	How often the backup cleanup and integrity check task should run (in Days).	Positive Integers (Default: 7)	`backup_integrity_check_schedule=3`

Example Call JETAPI

jetbackup5api -F manageSettingsPerformance -D "backup_forks=5&limit_account_downloads=10"

success: 1
message: Performance Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  backup_forks: 5
  queueable_forks: 5
  system_forks: 5
  backup_fork_ttl: 0
  mysqldump_max_packet: 0
  mysqldump_force: 1
  mysqldump_opt: 1
  mysqldump_skip_lock: 1
  mysqldump_multibyte: 1
  directories_queue_priority:
  limit_account_downloads: 10
  backup_integrity_check_schedule: 7

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsPerformance&backup_forks=5&limit_account_downloads=10

runIntegrityCheck

This function allows you to execute an Integrity Check manually on demand.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	The destination Object ID.	For a list of Destination IDs, please use listDestinations	`_id=6169fde7916d0366563db4b2`
user_id	String	Optional The account user ID. Runs the Integrity Check only on the specified account. This option does NOT require the user_name.	For a list of user IDs, please use listAccounts	`user_id=9879fde8573d0125563dc4b2`
user_name	String	Optional The username of the account. Will run the Integrity Check on ALL accounts with the username (including orphan accounts). This option should NOT be included if using the `user_id`.	For a list of account usernames, please use listAccounts	`user_name=exampleUser`

Example Call JETAPI

jetbackup5api -F runIntegrityCheck -D "_id={$DESTINATION_ID}&user_id=9879fde8573d0125563dc4b2"

success: 1
message: Integrity check Added To The Queue
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=runIntegrityCheck&id={$DESTINATION_ID}

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.

Example Call JETAPI

jetbackup5api -F getSettingsResource

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  cpu_limit: 200
  io_read_limit: 0
  io_write_limit: 0

Example Call HTTP

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)

Example Call JETAPI

jetbackup5api -F manageSettingsResource -D "cpu_limit=0"

success: 1
message: Resource Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  cpu_limit: 0
  io_read_limit: 0
  io_write_limit: 0

Example Call HTTP

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

Restore Settings

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

getSettingsRestore

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

More Info

**Returns**
Parameter name	Type	Description
limit_times	String	The limit restore that can be performed per account. [ To disable insert 0 in either one of the fields ]
limit_hours	String	The limit restore performed per hour. [ To disable insert 0 in either one of the fields ]
package_selection	Boolean	Choose whether to to use live account package or backed packed while restoring
lock_homedir	Boolean	Choose whether to lock accounts homedir with 000 permissions while restoring homedir files or not

Example Call JETAPI

jetbackup5api -F getSettingsRestore

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
limit_times: 3
limit_hours: 1
package_selection: 2
lock_homedir: 0

Example Call HTTP

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

manageSettingsRestore

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

More Info

Parameter name	Type	Description	Possible Values	Example
limit_times	String	The limit restore that can be performed per account. [ To disable insert 0 in either one of the fields ]		`limit_times=3`
limit_hours	String	The limit restore performed per hour. [ To disable insert 0 in either one of the fields ]		`limit_hours=2`
package_selection	Boolean	Choose whether to to use live account package or backed packed while restoring	Live Account Package: 1 Backed up Package: 2	`package_selection=1`
lock_homedir	Boolean	Choose whether to lock accounts homedir with 000 permissions while restoring homedir files or not	Yes: 1 No: 0	`home_dir=0`

Example Call JETAPI

jetbackup5api -F manageSettingsRestore -D "limit_times=3&limit_hours=1&package_selection=2&lock_homedir=0"

success: 1
message: Restore Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
licenseIssue:
data:
limit_times: 3
limit_hours: 1
package_selection: 2
lock_homedir: 0

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsRestore&limit_times=3&limit_hours=1&package_selection=2&lock_homedir=0

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.

Example Call JETAPI

jetbackup5api -F getSettingsSecurity

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  plugin: 6509f689ccf13c8ba0026112
  restore: 0
  lock: 0

Example Call HTTP

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	Plugin ID of the Security Plugin Object		`_id=6509f689ccf13c8ba0026112`
restore	Boolean	Boolean flag to determine whether or not to Restore the most recent "clean" backup after detection.	0 1	`restore=1`
lock	boolean	Boolean flag to determine whether or not to Lock the most recent "clean"	0 1	`'lock=1'`

Example Call JETAPI

jetbackup5api -F manageSettingsSecurity -D "plugin={$SECURITY_PLUGIN_ID}&restore=1&lock=1"

success: 1
message: Security Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  plugin: 6509f689ccf13c8ba0026112
  restore: 1
  lock: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsSecurity&plugin={$SECURITY_PLUGIN_ID}&restore=1&lock=1

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.

Example Call JETAPI

jetbackup5api -F getSettingsPrivacy

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  user_agreement:
  privacy_policy:
  encryption_selection: 0
  forgotten_ttl: 0

Example Call HTTP

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`

Example Call JETAPI

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

success: 1
message: Privacy & Security Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel: 1
  agreement:
  licenseIssue:
data:
  user_agreement: Are you sure
  privacy_policy: Do you agree
  encryption_selection: 1
  forgotten_ttl: 30

Example Call HTTP

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.

**Panelless 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.

Example Call JETAPI

jetbackup5api -F getSettingsPanel

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel: 1
  agreement:
  licenseIssue:
data:
  options:
        default_owner: root
        default_ip:

=============================================

#Panelless

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
  data:
  options:
        default_db_user:
        assign_type: 1
        mysql_enabled: 0
        mysql_user: root
        mysql_password:
        mysql_host: localhost
        mysql_port: 3306
        mysql_socket:
        pg_enabled: 0
        pg_user:
        pg_password:
        pg_host: localhost
        pg_port:
        mongodb_enabled: 0
        mongodb_user:
        mongodb_password:
        mongodb_host: localhost
        mongodb_port: 27017
        mongodb_auth_db:

Example Call HTTP

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.

Example Call JETAPI

jetbackup5api -F manageSettingsPanel -D "options[default_owner]=example&options[default_ip]=1.2.3.4"

#Panelless

jetbackup5api -F manageSettingsPanel -D "options[default_db_user]=example&options[mysql_enabled]=1"

success: 1
message: Panel Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
 licenseIssue:
data:
  options:
        default_owner: example
        default_ip: 1.2.3.4

=============================================

#Panelless

success: 1
message: Panel Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
  data:
  options:
        default_db_user: example
        assign_type: 1
        mysql_enabled: 1
        mysql_user: root
        mysql_password:
        mysql_host: localhost
        mysql_port: 3306
        mysql_socket:
        pg_enabled: 0
        pg_user:
        pg_password:
        pg_host: localhost
        pg_port:
        mongodb_enabled: 0
        mongodb_user:
        mongodb_password:
        mongodb_host: localhost
        mongodb_port: 27017
        mongodb_auth_db:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsPanel&options[default_owner]=example&options[default_ip]=1.2.3.4

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.

Example Call JETAPI

jetbackup5api -F getSettingsSnapshots

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  backup:
  retain: 1
  ttl: 2
  rule_size: 5
  rule_inodes: 50000

Example Call HTTP

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`

Example Call JETAPI

jetbackup5api -F manageSettingsSnapshots -D "backup={$BACKUP_JOB_ID}&retain=5&ttl=3"

success: 1
message: Backup on Demand Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  backup: 65091af275e69fa2b808c0e2
  retain: 5
  ttl: 3
  rule_size: 5
  rule_inodes: 50000

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsSnapshots&backup={$BACKUP_JOB_ID}&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]=example@email.com

Example Call JETAPI

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

jetbackup5api -F manageNotificationIntegration -D "action=modify&_id={$NOTIFICATION_INTEGRATION_ID}&name=example&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients][email protected]"

success: 1
message: Notification Integration Created Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 6509fbecaa590ab6b3060b32
  name: example
  owner: 65075382d49adbd1660f06d2
  owner_name: root
  type: Email
  frequency:
        1: 2
        2: 1
        4: 1
  disabled:
  options:
        recipients:
          0: [email protected]

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageNotificationIntegration&action=create&name=example&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=modify&_id={$NOTIFICATION_INTEGRATION_ID}&name=example&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.

Example Call JETAPI

jetbackup5api -F listNotificationIntegrationTypes

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  types:
        0:
          key: Email
          name: Email
          description: Send notifications using SMTP or local mail server
          version: 5.3.3
        1:
          key: Syslog
          name: Syslog
          description: Syslog integration for JetBackup
          version: 1.1.0

Example Call HTTP

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

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

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.

Example Call JETAPI

jetbackup5api -F listNotificationIntegrations

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  notifications:
        0:
          _id: 65075381a8f98c6ea7022b64
          name: Default Email Notification
          owner: 650750535448a47911036b62
          owner_name:
          type: Email
          frequency:
                1: 1
                2: 1
                4: 1
          disabled:
          options:
                smtp:
        1:
          _id: 6509fbecaa590ab6b3060b32
          name: example
          owner: 65075382d49adbd1660f06d2
          owner_name: root
          type: Email
          frequency:
                1: 2
                2: 1
                4: 1
        disabled:
        options:
                recipients:
                0: [email protected]
total: 2

Example Call HTTP

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

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

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`

Example Call JETAPI

jetbackup5api -F getNotificationIntegration -D "_id={$NOTIFICATION_INTEGRATION_ID}"

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 6509fbecaa590ab6b3060b32
  name: example
  owner: 65075382d49adbd1660f06d2
  owner_name: root
  type: Email
  frequency:
        1: 2
        2: 1
        4: 1
  disabled:
  options:
        recipients:
          0: [email protected]

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getNotificationIntegration&_id={$NOTIFICATION_INTEGRATION_ID}

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`

Example Call JETAPI

jetbackup5api -F deleteNotificationIntegration -D "_id={$NOTIFICATION_INTEGRATION_ID}"

success: 1
message: Notification Integration Deleted Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=deleteNotificationIntegration&_id={$NOTIFICATION_INTEGRATION_ID}

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.

Example Call JETAPI

jetbackup5api -F getSettingsBinary

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  rsync: /usr/local/jetapps/usr/bin/rsync
  rear: /usr/local/jetapps/usr/bin/rear
  psql: psql
  pgrestore: pg_restore
  pgdump: pg_dump
  mysql: mysql
  mysqldump: mysqldump
  ionice: ionice
  tar: tar
  gzip: gzip
  gunzip: gunzip
  mongodump: /usr/local/jetapps/usr/bin/mongodump
  mongorestore: /usr/local/jetapps/usr/bin/mongorestore

Example Call HTTP

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`

Example Call JETAPI

jetbackup5api -F manageSettingsBinary -D "gzip=/usr/bin/gzip&tar=/usr/bin/tar"

success: 1
message: Binary Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  rsync: /usr/local/jetapps/usr/bin/rsync
  rear: /usr/local/jetapps/usr/bin/rear
  psql: psql
  pgrestore: pg_restore
  pgdump: pg_dump
  mysql: mysql
  mysqldump: mysqldump
  ionice: ionice
  tar: /usr/bin/tar
  gzip: /usr/bin/gzip
  gunzip: gunzip
  mongodump: /usr/local/jetapps/usr/bin/mongodump
  mongorestore: /usr/local/jetapps/usr/bin/mongorestore

Example Call HTTP

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

JETAPI Documentation

On This Page:

Settings

General Settings

getSettingsGeneral

manageSettingsGeneral

Performance Settings

getSettingsPerformance

manageSettingsPerformance

runIntegrityCheck

Resource Settings

getSettingsResource

manageSettingsResource

Restore Settings

getSettingsRestore

manageSettingsRestore

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: