Last modified November 7, 2024

listPackages

This function returns a list of available Plugin packages from Repositories.
Parameter name Type Description Possible values Example
filter String Filter packages by name or description.   filter=Slack
find List [] Find packages by name, type, repo ID, or code.   find[name]=Slack&find[type]=notification

Returns

Parameter name Type Description Possible values Example
items List [] Returns a list of all Plugin packages. To view the parameters returned by this function, click on Plugin Item Object.  
total Integer The total number of Package Items    

Example Call JETAPI

jetbackup5api -F listPackages -D "filter=destination&find[name]=SFTP&find[type]=destination"
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:
  packages:
    0:
      _id: 65075381a8f98c6ea7022b60
      code: SFTP
      name: SFTP
      description: Give you the ability to backup to any SFTP destination using JetBackup engine
      type: destination
      version: 1.0.1-2
      author: JetApps
      icon: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA4NpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDcuMS1jMDAwIDc5LmIwZjhiZTkwLCAyMDIxLzEyLzE1LTIxOjI1OjE1ICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIgeG1wTU06T3JpZ2luYWxEb2N1bWVudElEPSJ4bXAuZGlkOmEzMjI4YTNjLTYxOTAtNTQ0Yi1hZmViLTFhYjYzYTAyNmVjMyIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFM0YzRDdGNUZENjYxMUVEODcyM0IyOERBOUZCM0I1RCIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFM0YzRDdGNEZENjYxMUVEODcyM0IyOERBOUZCM0I1RCIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgMjEuMSAoV2luZG93cykiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoxN2Q4YzI5MS0yM2JlLWE3NDQtYTZmNC00MTlmZDhiNGZmNGMiIHN0UmVmOmRvY3VtZW50SUQ9ImFkb2JlOmRvY2lkOnBob3Rvc2hvcDowMjNjZWJjNy1jZWJkLTIxNGItOWVlYS02MWYyY2IyZGJjYTAiLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz5Kxj2KAAAHQ0lEQVR42tRaC2wUVRS99E/pl1poobQrlE8L0irSUtCWWOSnKKlfAn6iROKnMUjURDCgiIlG8INIVDRqMAVBY8In0FAEoogQkGKxAoKFtpSyYmmXtlu6sJ43d6azOzO73e12t/QlZ3dmdj7nvnvfvee92T52u516cwuiXt5Cuuk+JiAHyAIygKFAMhAv/94A1AFngEqgHDgIVPn64D4+hFA0cA8wHSgEUry8vgYoA3YA2wBLoAzoC8wBHgGmdhy9sBX9jE61/EnU8g+R9QJRewP/FgpHRCQRRd4MszPhFzgr6V7He5YCG4ESoNWfBtwFzJcNIGpGRJz+kKh+J2970/ohygZOIxr2Im9zEwasA3b7w4AXgGJgBLVfJvrjFQTBZqJrLb4FcXAkgu9BolvehafixJGTwGrg4+4yQMT6qzJCyLyH6PACOLqme9NJXwyhcZ8SJU4WezbgHRkWXwwQ5JcCi6S9qq+IjhT7Ny/ehs43PansrQTecGdEZwa8BSyWtvYh4Zh/DkxyT7yDKH+bsrcCWNIVA0TMvy+FzV5kDPMvga1QiZOICrYq4bTQ1ZgIcpNtiiXyZ74huvgrkT0osBDPFM/mYlssc/LIAyLPfyGlyvp9RHsf6FmtUPA90m2+kmKf1tYJIwOekgxob0SNREZoqfVQVYXB7bkQEfOI+mcjJcbC+VdQ3Cow+DcQnd+FnrV5b0DkYNT6PXw/NuBLd1ooWq6wyDZIPs11nuu9ZBSlkc8QxY4kCovjY+H9ebsvqnBYAkKixHsDBAfBJfcDkrltcsxKWg88KrnqCjTWdsiba26qenAErg5GLzcTpd5HdCseEpns+vw2yIrjqNonPutCsUNUz4RsihKaUVIBG1x5YLr0Wfk5dIxV2Ke/mejR0c8jXMZjB8Zb/0PIjHZPXvIG9NBojMUm6KTaXd4ZcN3KnMavUDgaGmCSVSXidS9nAh15xOGkNRBiSHFBXVDi4QijtNkQ1qgn1656d63gxK1Q5lqlNSBHksQ16J2mc/reF4TTZhENKvAtq8SOQFZBobrejhEHHpdPIGUe6vw6wUlwS5mSInPVGZAlfZqPGvd+H8Rh8mTf02JsOgbk25wcQiHk2pGpatG7v7/HfRYPud34N7LfBf21glvKFIXrd1oDMnjuhIuvG8S+rQ0Pa/bdgOBwyOfBzmGZ/jBRHLJXUCgy1gBODOUfIWtt4XGmNMHNkavGABblFqhMu8aAYOT4hDGIWxv5pYnwHDDO+Vj2SwgvDPhLFeoxS40zV40BnEZazM4GZD6OGcBDmFFhAIZEqsfP/cbfqbnqsStmzaDvR3TVwGva41GJ+nNi0pDZUD/+Pa4eazE7c9UYwBPw1iY1hHJfIxoF94ZGOZP8ERMQq1yhIxAOszGxqTsG2bFAI42XoQgt05MT11g1Fb4Ac4Hhheq+FXWjqc45nAU3R66GqxKKmErDYMmcyzHr2M7u5+/5cjxuAekKFMeEkc7HO4yYx9+bYHTmY6gF9xOdKmNjlXOPrOf94Q7XhscQ5b1OdGgVpqxHVG5u1GhDR6ESIZQxR09e+j2Ke+/AJ5jIw72z0HMTnvNtDIRHG2Q9VPmk24mmrkXATGBOikRRuGo8IITPACkLNF9Cj44yfpjkZpA+ihtXoHdiIdxmrFV/X5eubuet5B531YRXRGs8yuGmMwL9G4FoyYQXaw5yhlK56gw4I+XXKNQJ8198sVG7ikl8Wh4bIsbDT0sYYqwYhZC7lv0sfycMgxwxuT4vNZ89EJXiyFUXQpU8PNL55CYXk/Y9bxLtXKhmjxhT10NHdIJA/07uERLBnOLTnblqPFAufQ7M4pOPb+ZtbZu4iLOQCBUlmxShxF867b9JTf0x5qTyKVeTDuS0DBNQbRft62l2+5psu/3UDrvLVldht5894HzMctH1+W3Nnp+rbbuWMCdu1TJXibejB6rktconKPVOomOYfJQuxniHiMrAQAwJE9Y6aJpBcm5ucKjYIc772tba5vm5ojrbMB85BBl9YjsGcpHyS5njorDxhKaxmmg9LrBZb5A1dIyBeT+g04boJjTaVLNNWmgVJw6fwVXwRoDgwuRLZY4ul1Us8ioxSvvLyDJJLAZ7EoKD4MJto3aVzijZl0gQ1XHach79PQnBgSt1iYxOF7Za5SXuk5LSvHtpz5EXz2a1e1Lm1OrpytxueYnbRmMxmFPGBT50xDPHFilLi6tdvTPwfHG3ZD5R9eHAZJ0hID9nnc+Lu/rl9XKksh3L/Ut+OiR0VlG3La/rX3BUQRVuh01N9d1LPGYg0UxwNeV06wsO41dMVtyzDJ1TWSovgPnQQlGkMqYSFcLJEdF+ecWkXXZXX/I1QLEe/Bbidj9ve9PiIY2HTiTKmcvbagr320s+x+V3/WvWU/uIaiswCYdUv3ye5wpW2fuiZ4X0joN+umko0eAxqK75jvcM2GtW7djolS+6jZqJeuFfDW6I1uv/rfK/AAMA+9eecGfiFtoAAAAASUVORK5CYII=
      experimental: JetApps does not guarantee the error-free functionality of experimental features, and we provide it on an experimental basis only. You assume all risk for any function that you use marked "Experimental". Installation of this software could cause functionality failures, even for experienced administrators. Eventually this function will be released to our STABLE tier, once adequate testing and refinement is completed. Current ETA for STABLE release: Q3 2023
      repo: 6507537fa8f98c6ea7022b52
      repo_name: JetApps Repository
      package_md5sum: 2b4e1cf588499a5c62a449b0be24dec0
      package_url: jetbackup5-plugin-destination-sftp-1.0.1-2.zip
      created: 2023-09-19T05:04:40+00:00
      plugin:
      plugin_id:
      installed:
      installable: 1
  total: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listPackages&filter=destination&find[name]=SFTP&find[type]=destination