Last modified October 31, 2024

CloneJobs

manageCloneJob

This function allows you to create/modify the Clone Job Object.

getCloneJob

This function prints the objects data given its Clone Job ID.

listCloneJobs

This function lists all Clone Job Objects.

duplicateCloneJob

Function duplicates the given Clone Job’s configuration as a new Clone Job.

runCloneJobManually

Function manually runs the Clone Job given its Clone Job ID.

deleteCloneJob

This function allows you to delete the object given its Clone Job ID.

Parameter Dictionary

Clone Job Object

Parameter name Type Description Possible values Example
_id String Unique Clone Job ID   {_id: 5fcb1df43606876d134aab82}
name String Clone Job name used internally for your convenience.   "Full Account Clones"
destination List [] List of Destination IDs assigned for this backup job.    
destination_name List [] Names of the destinations assigned to this backup job.    
type Integer The integer value for the Clone Type
Account 1
{type: 1}
contains Integer The integer value for Contains. Full backup accounts will be the value of 511 which is 1+2+4+8+16+32+64+128+256(for all available backup options) (or 1|2|4|8|16|32|64|128|256 in binary operation).
Account Config 1
Account Homedir 2
Account Databases 4
Account Emails 8
Account Cron Jobs 16
Account Domains 32
Account Certificates 64
Account Database Users 128
Account FTP 256
Full Account 511
{contains: 511}
owner String The unique ID given to the owner.   5fc96deeac61ab0bc3020313
owner_name String The name assigned to the owner.   root
next_run String The date in UTC of the scheduled next run of the Clone Job.   2020-12-09T03:57:09+00:00
last_run String The date in UTC of the last scheduled run of the Clone Job.   2020-12-08T12:45:00+00:00
running Boolean Boolean value to determine if a backup job is currently running. null/1 1
disabled Boolean Boolean value to determine if a backup job is disabled. null/1  
exclude_list List [] List of the files/directories to exclude from backup job.    
encrypted Boolean Boolean value to determine if a backup job will encrypt the backups.    
schedules List [] List of Schedule Objects IDs.    
hooks List [] List of Hook Objects IDs.    
filters List [] List of Account Objects IDs.    
monitor List [] List of of the values set for the Clone Job Monitor.
  • ranfor: (int) days
  • notran: (int) days
  
default_package String The default package assigned to the account on the destination after cloning.    
default_owner String The default owner assigned to the account on the destination after cloning.