NOTICE: JetBackup For Linux is in ALPHA testing stage. Please handle with caution. Any information on this document is subject to change as we continue to develop and make changes.

manageDatabaseServer

Description

With this function, you can create/manage database servers.
To view the parameters that related to database type click on Database type related parameters.

Parameters

This is the basic parameters for all destination types.

Parameter name Type Description Possible values Example
_id String Required on action modify
The ID of the database server.
  5d269e0a2e74d50bb6113814
action String Required
The action you want to perform.
  • create
  • modify
 
name String Required on action create
Database Server name.
  local
type String Required on action create
Database Server type.
  • MySQL
  • MongoDB
  • PostgreSQL
 
authentication Object Required on action create
Available authentication parameters required to establish database connection.
To view the possible values click on Database type related parameters. authentication[hostname]=1.1.1.1&authentication[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 Required on authentication enabled
The hostname/ip of the database server.
   
port Integer Required on authentication enabled
The remote database server port. [Defaults to 3306(MySQL), 27017(MongoDB), 5432(PostgreSQL) if left empty]
  5432
username String Required on authentication enabled
Name of the database user.
   
password String Required on authentication enabled
Password of the database user.
   

Returns

This API call returns destination object.
To view the parameters that returned click on Database Object

Example