Last modified October 31, 2024

listPlugins

This function returns a list of installed Plugins.
Parameter name Type Description Possible values Example
filter String Filter installed plugins by name or description.   filter=SSH

Returns

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

Example Call JETAPI

jetbackup5api -F listPlugins -D "filter=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:
  plugins:
    0:
      _id: 65092ba4fbfef1a6a809f462
      code: S3
      name: S3 Compatible
      description: Generic S3 compatible destination, support AmazonS3, DigitalOcean Spaces, Wasabi, BackBlaze, IBM Cloud,Client Minio and any other s3 compatible object server that uses v4 signature
      icon:
      version: 1.1.2-8
      type: destination
      author: JetApps
      permissions: 1
      experimental:
      repo: 6507537fa8f98c6ea7022b52
      options:
      repo_name: JetApps Repository
      disabled:
      visible:
      available_package:
    1:
      _id: 65092ba6b8cb3377cb0fd9d2
      code: SSH
      name: SSH (Legacy)
      description: Give you the ability to backup to any SSH destination
      icon:
      version: 1.1.2-1
      type: destination
      author: JetApps
      permissions: 1
      experimental:
      repo: 6507537fa8f98c6ea7022b52
      options:
      repo_name: JetApps Repository
      disabled:
      visible:
      available_package:
  total: 2

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listPlugins&filter=destination