Last modified October 31, 2024

listDownloads

This function lists all Download Objects.
Parameter name Type Description Possible values Example
downloads List [] Returns a list of all available download objects. To view the parameters returned by this function, click on Download Object.  
total Integer The total number of Download objects available.    

Example Call JETAPI

jetbackup5api -F listDownloads
success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  downloads:
    0:
      _id: 6503ebe7effacb267509381e
      path: download_example_1694755815_10516.tar.gz
      full_path: /usr/local/jetapps/usr/jetbackup5/downloads/download_example_1694755815_10516.tar.gz
      size: 43589
      notes:
      backup_type: 1
      account: example
      account_name: example
      account_id: 6503eba4c6477f48c309376f
      items:
        0:
          _id: 6503ebb8ca4e13899d09378c
          name: example
          created: 2023-09-15T05:29:21+00:00
          backup_type: 1
          backup_contains: 1
        1:
          _id: 6503ebb8ca4e13899d09378d
          name: example
          created: 2023-09-15T05:29:21+00:00
          backup_type: 1
          backup_contains: 2
        2:
          _id: 6503ebb8ca4e13899d09378e
          name: example.com
          created: 2023-09-15T05:29:21+00:00
          backup_type: 1
          backup_contains: 32
        3:
          _id: 6503ebb8ca4e13899d09378f
          name: example.com
          created: 2023-09-15T05:29:21+00:00
          backup_type: 1
          backup_contains: 64
      created: 2023-09-15T05:30:15+00:00
  total: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi??function=listDownloads