Last modified May 14, 2025

manageDestination

This function allows you to create/modify the Destination Object.
Parameter name Type Description Possible values Example
id String The Destination ID to modify. N/A --id=2
type Integer The Destination Type.
  • Local
  • SFTP
  • GoogleDrive
  • S3
  • OneDrive
  • DropBox
  • Box
  • pCloud
 --type=GoogleDrive
name String The name given to the Destination for internal use. N/A --name="Google Drive Destination"
read_only Boolean Set the destination as Read-Only(Only allows restores and downloads of existing backups on the destination).
  • 0 - Disabled
  • 1 - Enabled
 --read_only=1
chunk_size Boolean Set the default read/write chunk size (MB).   --chunk_size=1
notes String Add internal notes to help identify or describe the destination (MB).   --notes="This is an example note"
free_disk Integer Set the Free Disk Limit (%) that JetBackup will check before performing a backup job. The job will be aborted if the available disk space is less than the configured limit. 0-99 (0 - disabled) --free_disk=95
backup_path String Define the directory path on the remote destination to store backups.   --backup_path=/PATH/TO/BACKUP
enabled Boolean Set the backup job to be enabled or disabled.
  • 0 - Disabled
  • 1 - Enabled
 --enabled=1
export_config Boolean Enable to backup JetBackup settings and configurations to the destination.
  • 0 - Disabled
  • 1 - Enabled
 --enabled=1
options String Provide connection details and other advanced options in JSON format.
  • 0 - Disabled
  • 1 - Enabled
 --options='{"host":"sftp_host","username":"sftp_user","password":"sftp_pass","port":22,"timeout":60,"retries":5}'

Example Call JETAPI

wp jetbackup manageDestination --name="S3" --enabled=1 --export_config=1 --type=S3 --chunk_size=5 --backup_path=/example/backups --options='{"access_key":"{$ACCESS_KEY}", "secret_key": "{$SECRET_KEY}", "bucket" : "exampleBucket", "endpoint" : "s3.us-west-1.amazonaws.com", "region" : "us-west-1"}'
Success
+----+------+-------------------+------+-------+---------+---------+---------+------------+--------+-----------------+
| ID | Name | Path              | Type | Notes | Enabled | Read On | Default | Limit Disk | Export | Jobs Assigned   |
+----+------+-------------------+------+-------+---------+---------+---------+------------+--------+-----------------+
| 4  | S3   | /example/backups  | S3   |       | Yes     | No      | No      | Disable    | Yes    | 0               |
+----+------+-------------------+------+-------+---------+---------+---------+------------+--------+-----------------+