manageDestination

Description

With this function, you can create/manage destination.

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 destination.
  5b30da08d5ac5e06897b47e2
action String Required
The action you want to perform.
  • create
  • modify
 
name String Required on action create
Destination name.
  local
type String Required on action create
Destination type.
  • Local
  • SSH
  • FTP
  • SFTP
  • Rsync.net
  • Amazon
  • Dropbox
  • GoogleDrive
  • Backblaze
  • CloneCpanel
 
engine Integer
Backup engine type.
Only on action create.
  • JetBackup - 1
  • cPanel - 2
1
path String Required on action create
The path to the folder you want your backup to be restored in.
  /localbackup
disabled Boolean Whether the destination is disabled.    
disasterrecovery Boolean Whether the DR is enabled for the destination.    
hidden Boolean Whether backups are hidden for the destination.    
schedules[] List
Exsist only on engine cPanel.
The scheduled reindex assign for the destination.
To create schedule click on manageSchedule
List of Job Schedule Id.
  schedules[][_id]=5b4c9375d5ac5e23e4463042
time Integer
Exsist only on engine cPanel.
The schedule reindex time for the destination.
  1200

Returns

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

Example