Last modified April 22, 2025

manageBackupJob

This function allows you to create/modify the Backup Job Object.
Parameter name Type Description Possible values Example
_id String The Backup Job ID to modify. N/A --id=24
type Integer The Backup Job Type.
  • 1 - Accounts
  • 2 - Config
 --type=1
backup_contains Boolean Set the backup job to be enabled or disabled.
  • 1 - Files only
  • 2 - Databases only
  • 3 - Full Backup
 --backup_contains=3
name String The name given to the Backup Job for internal use. N/A --name="Daily Backup"Backup
destination List [] List of the Destination IDs you will perform backups to. N/A --destinations='[2,4,5]'
excludes List [] List of File/Directory Paths to Exclude. N/A --excludes='["/test","/test2"]'
database_excludes List [] Exclude database tables from backup (json format). N/A --database_excludes='[tbl1, tbl2]'
job_monitor Integer Will notify you if the backup wasn't executed within the specified number of days. N/A --job_monitor=3
schedule_time Integer The time that you want to execute the backup job. N/A --schedule_time=13:00
schedules List[] The schedules that you want this backup job will be executed (json format). N/A --schedules='[{"_id":1,"retain":10}]'
enabled Boolean Set the backup job to be enabled or disabled.
  • 0 - Disabled
  • 1 - Enabled
 --enabled=1

Example Call JETAPI

wp jetbackup manageBackupJob --name="Weekly Backup" --type=1 --destinations='[1]' --schedules='[{"_id":1,"retain":10}]' --excludes='["/test","/test2"]' --schedule_time=13:00 --backup_contains=3
Backup job created successfully
+----+---------------+---------+--------------+-------------------+----------+---------+---------------+-----------------+--------------------+---------------+---------+--------------------+
| ID | Name          | Type    | Contains     | Next Run          | Last Run | Enabled | Excludes      | Destinations    | Schedules          | Schedule Time | Monitor | Excluded Databases |
+----+---------------+---------+--------------+-------------------+----------+---------+---------------+-----------------+--------------------+---------------+---------+--------------------+
| 4  | Weekly Backup | Account | Full Account | 22-Apr-2025 11:00 | Never    | Yes     | /test, /test2 | Default (Local) | Daily (Retain: 10) | 13:00         | 0       |                    |
+----+---------------+---------+--------------+-------------------+----------+---------+---------------+-----------------+--------------------+---------------+---------+--------------------+