Last modified November 7, 2024

getPlugin

This function returns the Plugin details.
Parameter name Type Description Possible values Example
_id String REQUIRED The Plugin ID.   _id=608b1c5f160247613b11dc02

To view available listing parameters, please visit List Parameters.

Returns

Parameter name Type Description Possible values Example
items List [] Returns a list of data for the Plugin Object. To view the parameters returned by this function, click on Plugin Item Object.  

Example Call JETAPI

jetbackup5api -F getPlugin -D "_id={$PLUGIN_ID}"
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:
  _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:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getPlugin&_id={$PLUGIN_ID}