Clone Jobs

manageCloneJob

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

Parameters

Parameter name Type Description Possible values Example

action String REQUIRED Sets the flag to either create or modify. 'create/modify' 'action=create'

_id String REQUIRED on action modify. The Clone Job ID. _id=5f8a7d0d348232507c4e7f02

type Integer REQUIRED on action create. The Clone Type. View all possible Clone Types below. 'type=1'

name String REQUIRED on action create. The name given to the Clone Job for internal use. "Daily Clone"

destination List [] REQUIRED on action create. List of the Destination IDs you will perform clones to. Must be a Clone Destination Type. 'destination[0]=5fcedb7e4caee42621624bc2'

contains Integer REQUIRED on action create. Value indicating what the backup contains. View all possible Contains Values below. 'contains=511'

default_owner String The default owner you would like to set for your account for the Destination Server. If left blank, JetBackup will try to use the live owner. root

default_package String The default package you would like to set for your account for the Destination Server. If left blank, JetBackup will try to use the live package. user

Owner String Owner of the Clone Job. The owner and his parent will have permissions to modify/delete this destination admin

monitor List [] Set the values for the Clone Job Monitor. (0: disabled)

ranfor: (int) days

notran: (int) days

monitor[ranfor]=1&monitor[notran]=2

Disabled Boolean Flag to know if a Clone Job is Disabled 1/0

Parameter name	Type	Description	Possible values	Example
action	String	REQUIRED Sets the flag to either create or modify.	'create/modify'	`'action=create'`
_id	String	REQUIRED on action modify. The Clone Job ID.		`_id=5f8a7d0d348232507c4e7f02`
type	Integer	REQUIRED on action create. The Clone Type.	View all possible Clone Types below.	`'type=1'`
name	String	REQUIRED on action create. The name given to the Clone Job for internal use.		`"Daily Clone"`
destination	List []	REQUIRED on action create. List of the Destination IDs you will perform clones to. Must be a Clone Destination Type.		`'destination[0]=5fcedb7e4caee42621624bc2'`
contains	Integer	REQUIRED on action create. Value indicating what the backup contains.	View all possible Contains Values below.	`'contains=511'`
default_owner	String	The default owner you would like to set for your account for the Destination Server. If left blank, JetBackup will try to use the live owner.		root
default_package	String	The default package you would like to set for your account for the Destination Server. If left blank, JetBackup will try to use the live package.		user
Owner	String	Owner of the Clone Job. The owner and his parent will have permissions to modify/delete this destination		admin
monitor	List []	Set the values for the Clone Job Monitor. (0: disabled)	ranfor: (int) days notran: (int) days	`monitor[ranfor]=1&monitor[notran]=2`
Disabled	Boolean	Flag to know if a Clone Job is Disabled	1/0

Example Call JETAPI

jetbackup5api -F manageCloneJob -D \
"action=create&\
name=API Clone Job&\
owner={$OWNER_ACCOUNT_ID}&\
owner_name={$OWNER_ACCOUNT_NAME}&\
destination[0]={$DESTINATION_ID1}&\
type=1&\
contains=511&\
structure=1&\
filters[0][0]={$GROUP_FILTER_ID1}&\
filters[1][0]={$GROUP_FILTER_ID2}&\
filters[1][1]={$GROUP_FILTER_ID3}&\
exclude_list[0]=.MirrorSearch&\
exclude_list[1]=*/.wysiwygPro_*&\
exclude_list[2]=*/core.[0-9]*& \
schedules[0][_id]={$SCHEDULE_ID1}&\
schedules[0][retain]=5&\
schedules[1][_id]={$SCHEDULE_ID2}\
schedules[1][retain]=5&\
time=2330&\
monitor[ranfor]=1&\
monitor[notran]=1

success: 1
message: Clone Job Created Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: STABLE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 6505d2adf947d135e236c502
  name: clonetest
  destination:
    0: 6505d08d5cde724d10441b52
  destination_details:
    0:
      _id: 6505d08d5cde724d10441b52
      name: clone
      owner: 64f37d695aa01f55661b38f2
      owner_name: root
      type: Clones
      job_type: 2
      count: 1
      hidden:
      readonly:
      disabled:
      disk_limit: 95
      disk_usage:
      threads: 10
      update_date: 2023-09-16T15:58:08+00:00
      dr:
      reindex:
      running:
      options:
        password: JB|HIDDEN|********************
        privatekey:
        host:
        port:
        timeout: 60
        rsyncpreferip: 0
        rsyncbwlimit: 0
        internalprivatekey:
  type: 1
  contains: 511
  options: 0
  state: 0
  owner: 64f37d695aa01f55661b38f2
  owner_name: root
  next_run:
  last_run:
  running:
  disabled: 0
  time: 2000
  monitor:
    ranfor: 0
    notran: 0
  manually_retain: 0
  exclude_list:
  schedules:
  hooks:
  default_package:
  default_owner:
  suspend_after: 0
  filters:`

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageCloneJob&action=modify&type=1

getCloneJob

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

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Clone Job ID.		`_id=5f8a7d0d348232507c4e7f02`

API call returns the Clone Job Object with matching Clone Job ID.

Example Call JETAPI

jetbackup5api -F getCloneJob -D "_id={$CLONEJOB_ID}"

success: 1
message:
system:
version: 5.3.3
tier: STABLE
type: cPanel
drMode:
agreement:
licenseIssue:
data:
_id:
name:
destination:
destination_name:
time: 0
time_parsed: 12:00 AM
flag: 0
options: 0
monitor:
        ranfor: 0
        notran: 0
performance:
        lve:
        ionice: 1
        renice: 1
limitaccounts: 0
maximumruntime: 0
schedules:
filters:
pid: 0
progress:
excludelist:
time_estimation: 0
last_run:
next_run:
owner: root
disabled:
running:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getCloneJob&_id={$CLONEJOB_ID}

listCloneJobs

This function lists all Clone Job Objects.

More Info

Example Call JETAPI

jetbackup5api -F listCloneJobs

success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
jobs:
        0:
        _id: 650b5b54b10f4943c95560c2
        name: clonetest - 16952430929669
        destination:
                0: 6505d08d5cde724d10441b52
        destination_details:
                0:
                _id: 6505d08d5cde724d10441b52
                name: clone
                owner: 64f37d695aa01f55661b38f2
                owner_name: root
                type: Clones
                job_type: 2
                count: 1
                hidden:
                readonly:
                disabled:
                disk_limit: 95
                disk_usage:
                threads: 10
                update_date: 2023-09-16T15:58:08+00:00
                dr:
                reindex:
                running:
                options:
                        password: JB|HIDDEN|********************
                        privatekey:
                        host:
                        port:
                        timeout: 60
                        rsyncpreferip: 0
                        rsyncbwlimit: 0
                        internalprivatekey:
        type: 1
        contains: 511
        options: 0
        state: 0
        owner: 64f37d695aa01f55661b38f2
        owner_name: root
        next_run: 2023-10-02T00:00:00+00:00
        last_run:
        running:
        disabled: 1
        time: 2000
        monitor:
                ranfor: 0
                notran: 0
        manually_retain: 0
        exclude_list:
        schedules:
                0:
                _id: 650b5b54b10f4943c95560c3
                name: monthly - 16952430921672
                type: 4
                next_run: 2023-10-02T00:00:00+00:00
                retain: 0
        hooks:
        default_package:
        default_owner:
        suspend_after: 0
        filters:
                0:
                0: 6505d92d8a390273c33702e3
total: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listCloneJobs

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

duplicateCloneJob

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

More Info

Parameters

Parameter name Type Description Possible values Example

_id String REQUIRED Clone Job ID. _id=5fcac5c16852ef21a56c9362

Example Call JETAPI

jetbackup5api -F duplicateCloneJob -D "_id={$CLONEJOB_ID}"

success: 1
message: Clone Job Duplicated Successfully
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
_id: 650b5b54b10f4943c95560c2
name: clone - 16952430929669
destination:
        0: 6505d08d5cde724d10441b52
destination_details:
        0:
        _id: 6505d08d5cde724d10441b52
        name: clone
        owner: 64f37d695aa01f55661b38f2
        owner_name: root
        type: Clones
        job_type: 2
        count: 2
        hidden:
        readonly:
        disabled:
        disk_limit: 95
        disk_usage:
        threads: 10
        update_date: 2023-09-16T15:58:08+00:00
        dr:
        reindex:
        running:
        options:
        password: JB|HIDDEN|********************
        privatekey:
        host:
        port:
        timeout: 60
        rsyncpreferip: 0
        rsyncbwlimit: 0
        internalprivatekey: 6505d08d5cde724d10441b52.rsa
type: 1
contains: 511
options: 0
state: 0
owner: 64f37d695aa01f55661b38f2
owner_name: root
next_run: 2023-10-02T00:00:00+00:00
last_run:
running:
disabled: 1
time: 2000
monitor:
        ranfor: 0
        notran: 0
manually_retain: 0
exclude_list:
schedules:
        0:
        _id: 650b5b54b10f4943c95560c3
        name: monthly - 16952430921672
        type: 4
        next_run: 2023-10-02T00:00:00+00:00
        retain: 0
hooks:
default_package:
default_owner:
suspend_after: 0
filters:
        0:
        0: 6505d92d8a390273c33702e3

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=duplicateCloneJob&_id={$CLONEJOB_ID}

runCloneJobManually

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

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Clone Job ID.		`_id=5f8a7d0d348232507c4e7f02`

Example Call JETAPI

jetbackup5api -F runCloneJobManually -D "_id={$CLONEJOB_ID}"

success: 1
message: Clone Job will be added to the queue. Please note that this job may not run and will be aborted by hooks or there conditions. If this job will be aborted it will be logged in the alerts section.
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
_id: 6505d2adf947d135e236c502
name: clonetest
destination:
        0: 6505d08d5cde724d10441b52
destination_details:
        0:
        _id: 6505d08d5cde724d10441b52
        name: clone
        owner: 64f37d695aa01f55661b38f2
        owner_name: root
        type: Clones
        job_type: 2
        count: 2
        hidden:
        readonly:
        disabled:
        disk_limit: 95
        disk_usage:
        threads: 10
        update_date: 2023-09-16T15:58:08+00:00
        dr:
        reindex:
        running:
        options:
                password: JB|HIDDEN|********************
                privatekey:
                host: 45.56.122.197
                port: 2222
                timeout: 60
                rsyncpreferip: 0
                rsyncbwlimit: 0
                internalprivatekey: 6505d08d5cde724d10441b52.rsa
type: 1
contains: 511
options: 0
state: 2
owner: 64f37d695aa01f55661b38f2
owner_name: root
next_run: 2023-10-02T00:00:00+00:00
last_run: 2023-09-20T20:45:48+00:00
running: 1
disabled: 0
time: 2000
monitor:
        ranfor: 0
        notran: 0
manually_retain: 0
exclude_list:
schedules:
        0:
        _id: 6505e1432302db737e179a82
        name: monthly
        type: 4
        next_run: 2023-10-02T00:00:00+00:00
        retain: 0
hooks:
default_package:
default_owner:
suspend_after: 0
filters:
        0:
        0: 6505d92d8a390273c33702e3

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=runCloneJobManually&_id={$CLONEJOB_ID}

deleteCloneJob

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

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED Clone Job ID.		`_id=5fcac5c16852ef21a56c9362`

Example Call JETAPI

jetbackup5api -F deleteCloneJob -D "_id={$CLONE_JOB_ID}"

success: 1
message: Clone Job Deleted Successfully
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=deleteCloneJob&_id={$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

{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

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.

JETAPI Documentation

On This Page:

Clone Jobs

manageCloneJob

getCloneJob

listCloneJobs

duplicateCloneJob

runCloneJobManually

deleteCloneJob

Parameter Dictionary

Clone Job Object

On This Page: