Plugins

listPlugins

This function returns a list of installed Plugins.

Parameters

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

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

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listPackages

This function returns a list of available Plugin packages from Repositories.

More Info

Parameters

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

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listRepositories

This function returns a list of available Repositories.

More Info

Parameters

Parameter name Type Description Possible values Example

filter String Filter repositories by name or description. filter=JetApps Repository

Returns

Parameter name Type Description Possible values Example

items List [] Returns a list of all repositories.

Example Call JETAPI

CALL

RESPONSE
jetbackup5api -F listRepositories -D "filter=JetApps Repository"
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:
  repositories:
    0:
      _id: 6507537fa8f98c6ea7022b52
      name: JetApps Repository
      url: https://repo.jetlicense.com/plugins/
      created: 2023-09-17T19:29:03+00:00
      last_checked: 2023-09-19T05:04:40+00:00
  total: 1
Example Call HTTP
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listRepositories&filter='JetApps Repository'
To view available listing parameters, please visit List Parameters.

API List calls have a default limit of 100 items.

Parameter name	Type	Description	Possible values	Example
filter	String	Filter repositories by name or description.		`filter=JetApps Repository`

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of all repositories.

manageRepository

This function lets you manage Repositories.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED for Modify The Repository ID.		`_id=608b1c5f160247613b11dc02`
action	String	REQUIRED Flag to either create or modify the Repository.	create/modify	`action=create`
url	String	The URL of the repository		`url="https://repo.jetlicense.com/plugins/"`
name	string	Set or change the Repository name for internal use		name=JetApps Repository

Example Call JETAPI

jetbackup5api -F manageRepository -D "action=create&url="https://repo.jetlicense.com/plugins/"&name=JetApps Repository"

jetbackup5api -F manageRepository -D "action=modify&_id={$REPOSITORY_ID}&name=JetApps Repository"

success: 1
message: Repository Created/Updated Successfully
system:
  version: 5.3.6
  version_panel: 5.3.6
  tier: ALPHA
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 65832695cdd0c01e2a099172
  name: JetApps Repository
  url: https://repo.jetlicense.com/plugins/
  created: 2023-12-20T17:38:28+00:00
  last_checked: 2023-12-20T17:38:30+00:00

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageRepository&action=create&url="https://repo.jetlicense.com/plugins/"&name=JetApps Repository

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageRepository&action=modify&_id={$REPOSITORY_ID}&name=JetApps Repository

deleteRepository

This function deletes Repositories.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Repository ID.		`_id=608b1c5f160247613b11dc02`

Example Call JETAPI

jetbackup5api -F deleteRepository -D "_id={$REPOSITORY_ID}"

success: 1
message: Repository Deleted Successfully
system:
  version: 5.3.6
  version_panel: 5.3.6
  tier: ALPHA
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

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

getPlugin

This function returns the Plugin details.

More Info

Parameters

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.

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}

managePlugin

This function lets you manage and enable Plugins.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`
disabled	Boolean	True if disabled.		1
repo	string	Set or Change the Repository by Repo ID.		`repo=608b1c707cf97c14601472e2`
visible	Boolean	JetBackup Linux Only True if visiblility enabled in JetBackup Panel.		1
permissions	Integer	JetBackup Linux Only The Plugin permission value (may vary by Plugin).	1 (Root Access) 3 (Root & Reseller Access) 7 (Root, Reseller & User Access)

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.

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 managePlugin -D "_id={$PLUGIN_ID}&disabled=0&visible=1&permissions=7"

success: 1
message: Plugin Updated 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: 7
  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:
  visible: 1
  available_package:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=managePlugin&_id={$PLUGIN_ID}&disabled=0&visible=1&permissions=7

installPlugin

This function allows you to install a Plugin given its package id or zip file.

More Info

Parameters

Parameter name	Type	Description	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.

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}

NOTE: When using the package_name parameter, the plugin.zip file must be in the /usr/local/jetapps/tmp/jetbackup5/plugins/ directory

uninstallPlugin

This function allows you to uninstall the Plugin given it's Plugin ID.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`

Example Call JETAPI

jetbackup5api -F uninstallPlugin -D "_id={$PLUGIN_ID}"

success: 1
message: Plugin uninstalled 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:

Example Call HTTP

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

updatePlugin

This function manually updates an installed plugin.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Plugin ID.		`_id=608b1c5f160247613b11dc02`

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.

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 updatePlugin -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: 650c784eb4dc9808390ea892
  code: Syslog
  name: Syslog
  description: Syslog integration for JetBackup
  icon:
  version: 1.1.0
  type: notification
  author: JetApps
  permissions: 1
  experimental:
  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=updatePlugin&_id={$PLUGIN_ID}

listAvailablePlugins

This function returns a list of compressed plugin files that are downloaded and available to install.

More Info

Parameters

Parameter name Type Description Possible values Example

filter String Filter plugins by name or description. filter=SSH

Parameter name	Type	Description	Possible values	Example
filter	String	Filter plugins by name or description.		`filter=SSH`

Returns

Parameter name Type Description Possible values Example

data List [] Returns an array of compressed plugin ID's. 0: 607ed9abc2bea96e77403c21.zip

total Integer The total number of Installed Plugin Items

Parameter name	Type	Description	Possible values	Example
data	List []	Returns an array of compressed plugin ID's.		`0: 607ed9abc2bea96e77403c21.zip`
total	Integer	The total number of Installed Plugin Items

Example Call JETAPI

jetbackup5api -F listAvailablePlugins

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: jetbackup5-plugin-addon-jetbackup-mc-1.1.0.zip
  total: 1

Example Call HTTP

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

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

manageSecurityPlugin

This function enables or disables the Imunify360 Security Plugin. If no data is passed to the manageSecurityPlugin API call, the plugin is disabled.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
plugin	String	REQUIRED The Security Plugin ID.		`plugin=6095b151ae9021718f3c75022`
lock	Boolean	Boolean flag to determine whether or not to Lock the most recent "clean" backup after detection.	0 (false) 1 (true)	`lock=1`
restore	Boolean	Boolean flag to determine whether or not to Restore the most recent "clean" backup after detection.	0 (false) 1 (true)	`restore=1`

Example Call JETAPI

jetbackup5api -F manageSettingsSecurity -D "plugin={$SECURITY_PLUGIN_ID}&restore=1&lock=1"

success: 1
message: Security Settings Updated 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:
  plugin: 6509f689ccf13c8ba0026112
  restore: 1
  lock: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsSecurity&plugin={$SECURITY_PLUGIN_ID}&restore=1&lock=1

Parameter Dictionary

Plugin Object

**Plugin Object**
Parameter name	Type	Description	Examples
_id	String	ID of the Plugin.	60903b9f6913fc54281a01
code	String	Short name for the Plugin.	S3
name	String	The name of the Plugin.	S3 Compatible
description	String	Description of the Plugin.	Generic S3 compatible destination
icon	String	Icon data.	N/A
type	String	Type of Plugin	security, notification
version	Integer	Plugin release version.	1.0.0
author	String	Author of the Plugin	JetApps
experimental	Boolean	True if plugin is experimental.	1
repo	string	Repository ID	608b1c707cf97c14601472e2
repo_name	String	Repository Name	JetApps Repository
package_md5sum	String	md5 checksum for the plugin package.	88cccac198f703042502797781b
package_url	String	Package Zip File	jetbackup-plugin-notification-telegram-1.0.0.zip
created	String	Date-Time the Plugin was fetched from the Repo.	2021-05-07T18:40:48+00:00
plugin	List []	A list of corresponding data associated with an installed Plugin Ojbect.	_id (string) code (string) name (string) description (string) version (integer) type (string) author (string) permissions (integer) experimental (boolean) repo (string) options (List []) repo_name (string) disabled (boolean) visible (boolean) available_package (string)
plugin_id	String	ID of the Plugin in JetBackup.	60903b9f6913fc54281a01f2
installed	Boolean	True if plugin is installed.	1
installable	Boolean	True if plugin can be installed.	1
disabled	Boolean	True if plugin is disabled.	0
options	List []	Array of Plugin options or settings.	N/A
available_package	Boolean	True if plugin is disabled.	0

Notification Integration Object Options

**Notification Integration Object Options**
More information on installing a Notification Integration
Option Name	Description	Plugin(s)	Examples
recipients	Email addresses that the notifications will be sent to	Email	`options[recipients]=example@email.com,example2@email.com`
smtp	Select the Email Server (Local PHP Mailer/SMTP).	Email	`options[smtp]=0`: Local PHP Mailer `options[smtp]=1`: SMTP
smtp_from	Reply-to email address. [Required for SMTP Email Server]	Email	`options[smtp_from]=example@email.com`
smtp_host	SMTP email server hostname. [Required for SMTP Email Server]	Email	`options[smtp_host]=smtp.examplemail.com`
smtp_port	SMTP email server port. [Required for SMTP Email Server]	Email	`options[smtp_port]=25`
smtp_username	SMTP username. [Required for SMTP Email Server]	Email	`options[smtp_username]=exampleUser@email.com`
smtp_password	SMTP password. [Required for SMTP Email Server]	Email	`options[smtp_password]=examplePass`
smtp_secure	SMTP encryption protocol (None/SSL/TLS). [Required for SMTP Email Server]	Email	`options[smtp_secure]=` `options[smtp_secure]=ssl` `options[smtp_secure]=tls`
smtp_verifyssl	SSL verification on SMTP connection (Yes/No). [Required for SMTP Encryption Protocol SSL/TLS]	Email	`options[smtp_verifyssl]=0`: No `options[smtp_verifyssl]=1`: Yes
smtp_timeout	Authentication connection timeout in seconds. [Required for SMTP Email Server]	Email	`options[smtp_timeout]=15`
teams_id	Group ID.	Microsoft Teams	`options[teams_id]=1a2b3c4d-78e9-123d-abc135def123`
client_id	Client ID.	Microsoft Teams	`options[client_id]=1a2b3c4d-78e9-123d-abc135def123`
client_secret	Client secret	Microsoft Teams	`options[client_secret]=1a2b3c4d-78e9-123d-abc135def123`
tenant_id	Tenand ID	Microsoft Teams	`options[tenant_id]=1a2b3c4d-78e9-123d-abc135def123`
authorization_code	Authorization code	Microsoft Teams	`options[authorization_code]=OAAABAAAAiL9Kn2Z27UubvWFPbm0gLWQJVzCTE9UkP3pSx1aXxUjq3n8b2JRLk4OxVXr`
channel_name	Name of channel to receive notifications on.	Microsoft Teams	`options[channel_name]=JetBackup`
channel_selection	Select channel by Channel Name/Channel ID	Slack	`options[channel_selection]=0`: Channel Name `options[channel_selection]=1`: Channel ID
channel_id	ID of Channel to receive notifications.	Slack	`options[channel_id]=ABC123DEF45`
channel	Name of channel to receive notifications on.	Slack	`options[channel]=JetBackup`
token	Bot User OAuth access token/Bot Token	Slack Telegram	`options[token]=abcd-234052363731-5439195628753-ii4q6IG7hdjN7k43K9OtqfzL`

JETAPI Documentation

On This Page:

Plugins

listPlugins

listPackages

listRepositories

manageRepository

deleteRepository

getPlugin

managePlugin

installPlugin

uninstallPlugin

updatePlugin

listAvailablePlugins

manageSecurityPlugin

Parameter Dictionary

Plugin Object

Notification Integration Object Options

On This Page: