Last modified November 7, 2024

runBackupJobManually

Function manually runs the Backup Job given its Backup Job ID.
Parameter name Type Description Possible values Example
_id String REQUIRED The Backup Job ID. N/A _id=5f8a7d0d348232507c4e7f02

Example Call JETAPI

jetbackup5api -F runBackupJobManually -D "_id={$BACKUP_JOB_ID}"
success: 1 message: Backup 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: 6504c79fd4b57d536c05bbe2 name: job1 destination: 0: 6503eec8ebbf07708d06f1d2 destination_details: 0: _id: 6503eec8ebbf07708d06f1d2 name: s3 owner: 6503d48bfc45b1addf0a9632 owner_name: root type: S3 job_type: 1 count: 3 hidden: readonly: disabled: disk_limit: 0 disk_usage: threads: 10 update_date: 2023-09-20T16:57:36+00:00 dr: 1 reindex: running: options: path: /test access_key: secret_key: JB|HIDDEN|******************** region: us-west-1 bucket: bucket endpoint: s3.us-west-1.amazonaws.com legacy: type: 1 contains: 511 structure: 1 options: 0 state: 2 owner: 6503d48bfc45b1addf0a9632 owner_name: root next_run: last_run: 2023-09-20T14:39:10+00:00 running: 1 retry_failed: 0 disabled: 0 time: 1700 backup_quota: monitor: ranfor: 0 notran: 0 manually_retain: 0 exclude_list: 0: /home 1: /root encrypted: 0 schedules: hooks: mysql_exclude_db_by_size: 0 postgresql_exclude_db_by_size: 0 mongodb_exclude_db_by_size: 0 filters: 0: 0: 6503e82270c7bdb29f08c6b3 1: 6503e82270c7bdb29f08c6b3

Example Call HTTP

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