Last modified May 27, 2025

manageSettingsGeneral

This function allows you to create/modify the Settings General Objects.
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
use_community_languages Boolean Use local translation files, or translation from our community languages CDN
  • 1 : true
  • 0 : false
    		•  use_community_languages=1
    show_damaged_backups Boolean Select the option to show damaged backups to end users
  • 1 : true
  • 0 : false
    		•  show_damaged_backups=1
    email_integration String Select the default email notification integration used by the system to send emails. Available options can be found using the listNotificationIntegrations API email_integration=670a937cd99ecc588a01a455
    time_format String Select the preferred time format. Use "12" for 12-hour clock or "24" for 24-hour clock.
  • 12
  • 24
    		•  time_format=12

    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