System
getMasterEncryptionKey
This function prints the objects data given its Master Encryption Key Object for Disaster Recovery.
More Info
jetbackup5api -F getMasterEncryptionKey
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getMasterEncryptionKey
Response Data
| Parameter name |
Type |
Description |
Possible Values |
Example |
|---|
| encryption_key |
String |
Your Master Encryption Key used for Disaster Recovery. |
N/A |
{
"encryption_key": "PCCgH+60SRFID+r3sHAHwg=="
}
|
|---|
factoryReset
This function is the same as New Installation on the Disaster Recovery Page.
Using this JETAPI Call will delete ALL current JetBackup 5 Configuration Data.
More Info
Parameters:
| 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 |
|
|---|
jetbackup5api -F factoryReset
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=factoryReset
exitDisasterRecovery
This function will skip the installation screen after reinstalling JetBackup 5.
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.
More Info
jetbackup5api -F exitDisasterRecovery
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=exitDisasterRecovery
approveAgreement
This function allows you to approve the JetBackup EULA Agreement via API.
More Info
jetbackup5api -F approveAgreement
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=approveAgreement
approveShowcase
This function allows you to approve the Showcase Modals via API.
More Info
Parameters
| Parameter name |
Type |
Description |
Possible values |
Example |
|---|
| _id |
String |
REQUIRED Showcase ID. |
Use listShowcase to view all available Showcase IDs. |
{
"_id": "110_jb4ToJb5Migration"
}
|
|---|
jetbackup5api -F approveShowcase -D \
'_id=110_jb4ToJb5Migration'
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=approveShowcase&_id=110_jb4ToJb5Migration
listShowcase
This function lists all available Showcase Agreements to approve.
More Info
jetbackup5api -F listShowcase
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listShowcase
Response Data
| 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
|
{
"features":
{
"0":
{
"_id": "110_jb4ToJb5Migration",
"feature": "jb4tojb5Migration",
"order": "110",
"approved": "1"
}
}
}
|
|---|
- To view available listing parameters, please visit List Parameters.
- API List calls have a default limit of 100 items.