NOTICE: This Documentation is for JetBackup 4 for Linux.

Please CLICK HERE for the latest JetBackup 5 for Linux Documentation.

Database Object

This is the basic parameters for all database type.
To view the parameters that related to database type click on Database type related parameters.


With this function, you can create/manage database servers.


This is the basic parameters for all destination types.

Parameter name Type Description Possible values Example
_id String The ID of the database server.   5d269e0a2e74d50bb6113814
name String Database Server name.   local
type String Database Server type.
  • MySQL
  • MongoDB
  • PostgreSQL
authentication Object Available authentication parameters required to establish database connection. Database type related parameters. authentication[hostname]=[username]=root&authentication[password]=********
options Object Available database options parameters. To view the possible values click on Database type related parameters. options[flag]=1&options[dump_max_packet]=2048
jobs_count Integer Number of jobs using the database server.    
enabled Boolean Whether authentication is enabled/disabled on the database server. (not available on MySql type)    
hostname String The hostname/ip of the database server.    
port Integer The remote database server port. [Defaults to 3306(MySQL), 27017(MongoDB), 5432(PostgreSQL) if left empty]   5432
username String Name of the database user.    
password String Password of the database user.