Last modified November 7, 2024

installPlugin

This function allows you to install a Plugin given its package id or zip file.
Parameter name Type Description Possible values Example
package_id String REQUIRED The Plugin ID.   package_id=608b1c5f160247613b11dc02
package_name String The compressed package file.   package_name=jetbackup-plugin-notification-syslog-1.0.5.zip
disabled Boolean Set to false to enable the plugin. Disabled by default.   disabled=0

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 installPlugin -D "package_id={$PLUGIN_ID}"

jetbackup5api -F installPlugin -D "package_name={$COMPRESSED_PACKAGE_FILENAME}"
success: 1
message: Plugin Installed 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: 65092deda67f7fafca057242
  code: JetBackupMC
  name: JBMC Backward Compatible Plugin
  description: Supporting plugin that allows the push of JetBackup 5 Data to the registered JetBackup MC Instance.
  icon: fas fa-star
  version: 1.1.0
  type: addon
  author: JetApps
  permissions: 1
  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.
  repo: 6507537fa8f98c6ea7022b52
  options:
  repo_name: JetApps Repository
  disabled: 1
  visible:
  available_package:

Example Call HTTP

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

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=installPlugin&package_name={$COMPRESSED_PACKAGE_FILENAME}