Last modified November 7, 2024

runCloneJobManually

Function manually runs the Clone Job given its Clone Job ID.
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}