Last modified November 7, 2024

manageDestinations

This function lets you manage the Destinations settings.
Parameter name Type Description Possible values Example
action String REQUIRED Flag to either create or modify the destination. create/modify action=create
_id String REQUIRED for Modify Unique ID given to every Destination upon creation.   _id=6140e800c6dcdd436e7cd362
type String REQUIRED on action create. The Destination Type
  • Local
  • S3
  • SSH
  • Clones
  • GoogleDrive
  • DropBox
  • OneDrive
  • FTP, SFTP
  • Localv2
type=SSH
name String REQUIRED on action create. Custom destination name for your convenience.   name=MyLocalDestination
owner String Owner(ID) of the Destination. The owner and his parent will have permissions to modify/delete this destination Owner will default to current logged-in user. owner=630e811f4ad52176890b3026
disabled Boolean True if destination is Disabled   disabled=0
readonly Boolean Create the destination as a Read-Only Destination. Read Only destinations only allow restore/download of backups already stored on the destination. Existing Destinations cannot be edited to Read-Only.    
dr Boolean Value indicating if the Destination is enabled for Export JB Config Backups.   dr=1
threads Integer Set the maximum concurrent threads that can be used by the destination for upload/download/get/delete requests. 1-400 threads=100
disk_limit Integer Sets the Disk Limit Percentage for the Destination. 0-100 disk_limit=95
hidden Boolean      
options Object REQUIRED on action create. Required options vary depending on destination type. Refer to Destination Options for more information.   options[path]=/backups
reindex Boolean      

Example Call JETAPI

jetbackup5api -F manageDestination -D "action=modify&_id={$DESTINATION_ID}&name={$NEWNAME}&disk_limit={disk_limit}"

jetbackup5api -F manageDestination -D "action=create&type=S3&name={$NAME}&threads=200&options[path]=/test&options[access_key]={$ACESS_KEY}&options[secret_key]={$SECRET_KEY}&options[bucket]={$BUCKET_NAME}&options[endpoint]={$REGION}.amazonaws.com&options[region]=us-west-1"
success: 1
message: Destination Created/Updated 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:
  name: s3-aws
  owner:
  owner_name: root
  type: S3
  job_type: 1
  count: 0
  hidden:
  readonly:
  disabled:
  disk_limit: 0
  disk_usage:
  threads: 10
  update_date: 2023-09-15T19:52:25+00:00
  dr:
  reindex: 1
  running:
  options:
    path: /test
    access_key:
    secret_key: JB|HIDDEN|********************
    region: us-west-1
    bucket: bucket
    endpoint: s3.us-west-1.amazonaws.com
  legacy:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageDestination&action=modify&_id={$DESTINATION_ID}&name={$NEWNAME}