Last modified October 31, 2024

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