Last modified October 31, 2024

getSettingsPanel

This function prints the objects data given its Settings Panel Object.
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