– System

Jb5: getMasterEncryptionKey

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible Values	Example
encryption_key	String	Your Master Encryption Key used for Disaster Recovery.	N/A	`encryption_key: tlVO8yTfCLuQPViqcYSzNA==`

Example Call JETAPI

jetbackup5api -F getMasterEncryptionKey

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

Jb5: factoryReset

Mon, 01 Jan 0001 00:00:00 +0000

Using this JETAPI Call will delete ALL current JetBackup 5 Configuration Data.

Parameter name	Type	Description	Possible Values	Example
drmode	Boolean	Optional flag used to indicate a Disaster Recovery. If disabled, the Default JB Config will be installed and the JetBackup 5 Panel will load with a fresh install.	N/A	`drmode=0`

Example Call JETAPI

jetbackup5api -F factoryReset

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

Jb5: exitDisasterRecovery

Mon, 01 Jan 0001 00:00:00 +0000

NOTE: Use factoryReset if installing JetBackup 5 as a Fresh Install. exitDisasterRecovery will not initialize JetBackup 5 and can lead to missing configurations like the Master Encryption Key.

Example Call JETAPI

jetbackup5api -F exitDisasterRecovery

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

Jb5: approveAgreement

Mon, 01 Jan 0001 00:00:00 +0000

Example Call JETAPI

jetbackup5api -F approveAgreement

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

Jb5: approveShowcase

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED Showcase ID.	Use listShowcase to view all available Showcase IDs.	`_id=110_jb4ToJb5Migration`

Example Call JETAPI

jetbackup5api -F approveShowcase -D \
'_id=110_jb4ToJb5Migration'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=approveShowcase&_id=110_jb4ToJb5Migration

Jb5: listShowcase

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible Values	Example
features	List []	List of all availble Feature Showcase Objects to Approve.	Feature Object Fields: _id feature order approved

Example Call JETAPI

jetbackup5api -F listShowcase

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

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