– JetBackup 5 Documentation

Jb5: A Guide to Upgrading to JetBackup 5

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

JetBackup 5 utilizes a new JetBackup Core and introduces a new Backup Structure and Engine. With that in mind, there will be NO DIRECT UPDATE from JetBackup 4 to JetBackup 5 and backups generated in JetBackup 4 ARE NOT COMPATIBLE with JetBackup 5.

NOTE: JetBackup v4.1.3+ is NOT compatible with JetBackup v5.3.0+, and cannot be installed on the same server.

You will need to install JetBackup v5.2.11 in order to upgrade from JetBackup 4. Please follow the steps to install JetBackup v5.2.11 and then update to v5.3+ once the migration is complete.

Benefits of the new JetBackup Core and Structure

Allows the flexibility to support multiple panels and operating systems, and be platform-agnostic
More granular control over backups and restores.
Ability to restore your account across multiple platforms and control panels.
Better backup performance and efficiency improvements.

For a side-by-side comparison between JetBackup 4 and JetBackup 5, please CLICK HERE.

With this in mind, you may install JetBackup 5 alongside your current installation of JetBackup 4 under the same license while you evaluate and transition over to JetBackup 5. This will allow you and your clients to continue utilizing JetBackup 4 while you transition and generate new backups in JetBackup 5.

To assist with upgrading from JetBackup 4 to JetBackup 5, we have created this guide with an accompanying script that walks you through importing all the supported settings and configurations from your JetBackup 4 instance over to JetBackup 5 to help minimize your overhead during your transition period.

Upgrade Preparations and Considerations

Installing JetBackup v5.2.11

Since JetBackup 4 is not compatible with JetBackup 5.3+ and therefore unable to be installed on the same server, you will need to install JetBackup v5.2.11 to start the upgrade process. To do so, you can you use the following command.

# Install JetBackup v5.2.11
yum install jetbackup5-cpanel-5.2.11 jetmongod-4.4.0.1 --disablerepo=* --enablerepo=jetapps,jetapps-stable

Destinations

Please review the supported Destination Types for JetBackup 5 to verify that your current JetBackup 4 destination is supported.

If your existing destination(s) is supported, you may continue to download and execute the configuration import tool.
If and you’ve obtained a supported destination that you want to assign to your backup job(s):
- Please set up the new destination in the Destinations Section before executing the script so you may assign your new destination to the JetBackup 4 backup job(s) that you'd like to import through the configuration import tool.
If you do not have any supported destinations to import or add, the script will also skip importing backup jobs but WILL continue to import your JetBackup 4 Hooks and Supported Settings.

The Following JetBackup 4 Destinations will not be imported:

SFTP*
Amazon S3**
Google Drive
DropBox
Backblaze B2**

*SFTP: Please check if your SFTP destination also supports the SSH protocol and you may be able to add it manually as an SSH destination in JetBackup 5.

Examples:

Hetzner Storage Box (SFTP → SSH)
NAS (SFTP → SSH): QNAP, Synology, FreeNAS, all support SSH. It may also be possible to mount these destinations locally using NFS v3 or 4.1.

**Amazon S3/Backblaze B2: JetBackup 5 does support both Amazon S3 and Backblaze B2 destinations and may be added as an S3 Compatible destination. With that said, there are differences in the implementation of these destinations in JetBackup 4 that prevent importing these destinations natively.

The following JetBackup 4 features are not available in JetBackup 5 and will not be imported over.

Clone Jobs
GDPR Backup Job*
Cloudlinux LVE Settings
Snapshots Settings

*GDPR Backup Job(s): You can now set up multiple Encrypted Backup Jobs in JetBackup 5, please visit Encrypted Backups for more information.

JetBackup 4 Backups

As mentioned previously, JetBackup 4 backups WILL NOT be usable in JetBackup 5. And so new backups will need to be generated once the upgrade is complete.

However, the JetBackup 4 backups can still be used for manual account restores using the cPanel restorepkg script.

Getting Started

To get you started, please go ahead and proceed to install JetBackup 5 on your server. For installation instructions please CLICK HERE.

Once Installed, please navigate to the JetBackup 5 admin interface to go over the JetBackup End User License Agreement(EULA) and select “New Installation” and complete the initial setup.

Next, please execute the following command to download and run the configuration import tool:

cd ~ && wget https://github.com/jetapps/jb4-jb5-import-tool/archive/refs/tags/v1.6.zip && unzip v1.6.zip && cd jb4-jb5-import-tool-1.6 && sh main.sh

All Imported DESTINATIONS, BACKUP JOBS, and HOOKS are DISABLED by default.

Installation Check

The tool first checks and verifies that you have a valid JetBackup 5 Installation.

If you do not have JetBackup 5 installed please follow these instructions to install JetBackup 5 on your server: JetBackup 5 Installation Guide

Importing Destinations

A list of ALL compatible destinations configured in your JetBackup 4 installation will be displayed:

Local
SSH
Rsync.net
FTP

If a backup job was assigned to a destination that’s not supported in the current JetBackup 5 version, you will be prompted to reassign the job to a new destination later.

If you do not have any supported Destinations to import, you may continue to import your settings and hooks by selecting "No" on the Import Destinations and Import Backup Jobs steps.

Please note that choosing to not import any destinations may result in skipping import of your Backup Job settings if no destinations are available in your JetBackup 5 installation. There needs to be at least 1 destination to assign backup jobs to.

For SSH Destinations, the import tool will automatically install and enable the new JetBackup 5 SSH Destination Plugin. Plugins are required to configure Destinations other than Local in JetBackup 5. For more information on JetBackup 5 Plugins please visit Plugins.

The import tool utilizes the JetBackup 4 private key to re-authenticate your SSH/Rsync.Net destination types. Your existing password/key will not be transferred over. Please note that the destination will be disabled after importing by default to allow you to review additional settings you may want to modify.

Importing Backup Jobs

A list of ALL Backup Jobs configured in your JetBackup 4 installation will be provided. The tool will go through each backup job prompting if you would like to import. For Backup Jobs with a non-compatible destination, the tool will prompt you to select a compatible destination from the imported destinations from the previous step (2). If there are no destinations available, the script will back up, alert you, and skip to the next section (Hooks).

JetBackup 5 also provides new backup options (Database users & FTP Accounts) to choose from and you may be prompted if you would like these items included. If your Backup Job was created as a Full Incremental Job with all options, these will be enabled by default.

Account Filters

The import tool will recreate the Account Filters you have set up in JetBackup 4 and prompt you which Backup Jobs you would like to assign the filter to.

Exclude List

The import tool will automatically import the exclude list configured on the original Backup Job.

Backup Schedules

The import tool will recreate the schedules as specified on the original Backup Job, including the retention and scheduled time. As for the “After backup job” schedule type, the tool checks if the specified backup job for this schedule has already been imported and will provide a warning otherwise.

Hooks

Supported hooks will be imported but are DISABLED by default as hooks that used parameters passed through the JetBackup 4 Hook/API system may require some refactoring to work with JetBackup 5. Please verify the functionality of your hook script before re-enabling it in JetBackup 5.

PLEASE NOTE: The mechanism for the hooks system has changed in JetBackup 5. Not all hook types are supported.

Additionally, the available options for each Hook type will be set to Empty by default (Hooks are set to execute on All available options). Please review your hooks and reset your preferred options.

Here is a list of unsupported hook types that won’t be imported:

Clone
Clone Account
Snapshot
Daily Cron

Settings

The import script will attempt to import all settings to JetBackup 5 when possible. Here are a list of JetBackup settings that will be imported by category.

General:
- Debug Active - Error Reporting - Delete orphan backups older than - Days to keep logs history - Manual Backups Retain - Manual Backups TTL
Performance
- *Concurrent Queued Tasks -> Concurrent Restore/Download Tasks - *Concurrent Scheduled Tasks -> Concurrent Backup Tasks - Limit accounts Downloads - Directory Queue Priority Group - MySQL Dump max allowed packet - MySQL Dump force flag - MySQL Dump opt flag - MySQL Dump skip lock table flag
Restore
- Restore Conditions (only imports content and will apply to all restore types)
Notification
- JetBackup 5 takes advantage of the plugins feature for notifications, including email notifications. It also streamlines notifications into 3 levels:
  - Information alerts, which constitutes notifications for when backups and restores and any background tasks such as reindexing, and plugin updates occur.
  - Warning alerts, for when JetBackup encounters non-fatal issues with JetBackup tasks such as partially completed backups and restores, issues with reaching your destinations or account specific issues.
  - Critical alerts, which notify of any major issues and failures affecting JetBackup such as backups and restore and other critical tasks.
- There are no more separate options to enable/disable tasks-specific notifications such as backups, restores, downloads, etc.

Post-Upgrade Recommendations

Now that you have your JetBackup 4 Configuration Imported over to JetBackup 5, you may want to start cleaning up backups in JetBackup 4 while you generate new backups in JetBackup 5 to reduce the storage overhead associated with your transition.

To do so, you may simply create an “Exclude All” account filter in JetBackup 4, set it with an Include Filter Condition without specifying any accounts.

Once the filter is created, you may then add the account filter to the backup job that you prefer to decommission. The Backup Job will then begin to clean up the backups for all the excluded accounts each time it runs as it continues to execute per the schedule set on the backup job.

It will take a maximum of one full cycle per the set schedule to completely remove all backups associated with your existing backup job(s). You are able adjust the schedule, but the type (hourly, daily, monthly) MUST be the same as when the backups were generated. If the schedule is removed, the backups there were generated with that schedule type will be cleaned up at 1:00 AM server time.

Uninstalling JetBackup 4

Once you feel you no longer need your JetBackup 4 installation, you may remove the JetBackup 4 package using following command.

yum remove jetbackup-core

This will uninstall only the JetBackup 4 package. You may check to see what packages are installed on your server using the following command:

jetapps --list-installed

Updating from v5.2.11 to v5.3+

After uninstalling JetBackup 4 you are able to update v5.2.11 to v5.3+. To do so, you can use the following command.

jetapps -a

Jb5: Backup System Files

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

Backup Server Config Files/Directories

Besides accounts, JetBackup can also backup generic system files & folders on the server. This is very useful if you want to backup important files and server config files that are not directly related to panel accounts.

In order to backup specific files/folders from your cPanel server, you need to choose a "Directories" backup type. For more information on Directories Backup Jobs, click here.

In the following screenshot, we created a Compressed Directories job that will backup important config files on a cPanel server. This backup job is also scheduled to be executed right after a our full account backup job finishes using the After Backup Job Done schedule type.

When selecting the Archived/Compressed Backup structure, you also have the option to enable the Encrypted Backups option so the backups are encrypted before transfer to the destination.

cPanel Include List

Here is a base list of files/folders we recommend to include on your backup job on cPanel & WHM servers. This is a generic list -- please see the next section if you'd like to generate a list automatically that's unique to your cPanel version/setup.

/etc/cpanel
/etc/proftpd
/etc/ssl
/etc/valiases
/etc/vdomainaliases
/etc/vfilters
/usr/local/cpanel/3rdparty/mailman
/var/cpanel
/var/lib/rpm
/var/lib/mysql
/var/named
/var/spool/cron
/etc/dovecot
/etc/exim.conf
/etc/exim.conf.local
/etc/exim.conf.localopts
/etc/fstab
/etc/group
/etc/httpd/conf/httpd.conf
/etc/ips
/etc/localdomains
/etc/mail/sni/map
/etc/my.cnf
/etc/named.conf
/etc/passwd
/etc/pure-ftpd.conf
/etc/quota.conf
/etc/remotedomains
/etc/reservedipreasons
/etc/reservedips
/etc/rndc.conf
/etc/secondarymx
/etc/shadow
/etc/wwwacct.conf
/root/.my.cnf
/usr/local/apache/conf/httpd.conf
/etc/sysconfig/network-scripts
/etc/rc.d/rc.local
/etc/sysconfig/network
/etc/resolv.conf

Using cPanel & WHM, you can generate a comprehensive list of ALL potential system files/configs on a cPanel & WHM environment. Please note that each individual cPanel server may vary depending on the software/features you have installed and NOT all paths in the Include/Exclude list generated may exist on your server.

The following command will generate a generic list of files and folders to INCLUDE in your backup job.

/usr/local/cpanel/3rdparty/bin/perl -MCpanel::Backup::SystemResources -MData::Dumper -e'print Dumper( Cpanel::Backup::SystemResources::get_resource_paths() )' | awk '/\//{print $1}' | tr -d "\'",","

The following command will generate a generic list of files and folders to EXCLUDE from your backup job.

/usr/local/cpanel/3rdparty/bin/perl -MCpanel::Backup::SystemResources -MData::Dumper -e'print Dumper( Cpanel::Backup::SystemResources::get_excludes_args_by_path("/var/cpanel") )' | awk '{print "/var/cpanel/" substr($3,12)}' | cut -d\' -f 1

DirectAdmin Include List

Here is a list of files/folders that are normally included with DirectAdmin's built-in "System Backup". This is a generic list -- Please note that each individual DirectAdmin server may vary depending on the software/features you have installed and NOT all paths in the generic Include List may exist on your server. Additionally, custom configuration/setup of DirectAdmin may include extra files/folders that are NOT listed.

/etc/bind
/etc/dovecot
/etc/exim.cert
/etc/exim.conf
/etc/exim.key
/etc/exim.pl
/etc/group
/etc/gshadow
/etc/hosts
/etc/httpd
/etc/httpd/conf/httpd.conf
/etc/httpd/conf/ips.conf
/etc/mail
/etc/master.passwd
/etc/named.conf
/etc/nginx
/etc/my.cnf
/etc/passwd
/etc/proftpd.conf
/etc/proftpd.passwd
/etc/proftpd.vhosts.conf
/etc/resolv.conf
/etc/shadow
/etc/ssh/sshd_config
/etc/system_filter.exim
/etc/virtual
/home/admin
/usr/lib/apache
/usr/local/directadmin/scripts/custom/
/usr/local/directadmin/conf/mysql.conf
/usr/local/directadmin/conf/directadmin.conf
/usr/local/directadmin/data
/usr/local/frontpage
/usr/share/ssl
/var/log
/var/mail
/var/named
/var/spool/cron
/var/spool/mail
/var/spool/virtual
/var/www

Jb5: Backblaze Configurations

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

Note: As an unsupported destination - we do NOT recommend using Backblaze B2 as a destination and will no longer provide any technical support for issues that directly involves Backblaze B2. For more information, please refer to our knowledgebase article.

Create Backblaze Bucket

Click on "Bucket" at the "B2 Cloud Storage" sidebar.

Click on "Create new bucket". Give your bucket a unique name, and choose "private".

Please take note of the bucket's name and region.

Backblaze default lifecycle configuration will keep all versions of the same file. This should be set to "Keep only last version" to prevent excess storage usage.

Create BackBlaze API Keys

Click on "App Keys" at the "B2 Cloud Storage" sidebar.

Click on "Add a New Application Key".

When not using master application keys, the application key must have all privileges (Read and Write) on the targeted bucket.

Please take note of the application key’s “KeyID” and “Application Key” for the Access/Secret Key portion.

Jb5: Overview

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

For video tutorials, please click here:

With the JetBackup Hooks System, you can trigger custom scripts when JetBackup executes an task on specific hook points. For example, you could use hooks to notify you through your preferred application when a backup job starts, completes or fails.

Create New Hook

To create a new hook, click on "+ Create New Hook".

Example configuration page for hooks:

Here's a sample script that goes through each parameter passed from the hook and prints the key(parameter name) and value of each parameter to a "testFile".

#!/usr/bin/php

// PHP sample for JetBackup hook
// All Hook Args are stored in $argv

<?php
for ($i = 1; $i < sizeof($argv); $i++) {
        $data = "Arg " . $i . ": " . $argv[$i] . "\r\n"; //Format Data
        file_put_contents("/root/testFile", $data, FILE_APPEND); //Append each arg to file
}
?>

#!/bin/bash

# Hook Args are passed into $@

echo Printing Hook Parameters: >> /root/testFile

argArray=( "$@" ) # Storing args in new array for printing

for i in "${!argArray[@]}"; do
        echo "Arg $i: ${argArray[$i]}" >> /root/testFile
done

#!/usr/bin/python

#Python sample for JetBackup 5 Hook

import sys

f = open("/root/PythonTestFile", 'w')

f.write("Printing Hook Parameters:\n")

for i in range(1,len(sys.argv)):

        f.write("Arg "+str(i)+": "+sys.argv[i]+"\n")

f.close()

Hook Name

This will be used internally your convenience.

Hook Position

Choose to run your script Pre/Post selected task.

Hook Type

The hook type defines which task the hook should be executed.

Each hook type receives a different set of arguments. Your script can fetch this data and use it to its own needs.

These are the available action type and the arguments that are passed:

Hook Script

The hook script must be an executable file specified by full path. For example:

/hooks/pre-backup.sh

If it’s not an executable script, such as regular PHP file you should specify the executable to run your script. For example:

/usr/bin/php /hooks/pre-backup.php

This executable should exit with success (0) if it executed successfully, Otherwise, if it fails, it should exit with an error code - other than 0.

Hook Settings

Enable/Disable Hook

Click on Disable/Enable Hook to Disable/Enable your Hook.

Manage Hook

Click on Manage Hook to modify Hook settings.

Delete Hook

Click on Delete Hook to Delete your Hook permanently.

Jb5: Overview

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

For video tutorials, please click here:

In this section, you can create and manage your Repositories, view and install Available Plugins, and manage Installed Plugins.

Installed Plugins

In the Installed Plugins tab, you can view and manage all installed plugins in JetBackup.

Plugin actions:

Enable Plugin

Click on "Enable Plugin" to toggle between enabling and disabling your plugins.

Uninstall Plugin

Click on "Uninstall Plugin" to permanently remove your plugins. Make sure that the plugin is not in use in order to uninstall it.

Available Plugins

In the Available Packages tab, you can view and intsall all available plugins from your repositories.

Plugin Type

Available Plguins

Destination Plugins

Plugins

✔️ SSH

✔️ S3 Compatible

Notification Plugins

Plugins

✔️ Slack	✔️ Telegram
✔️ Syslog

Addon Plugins

Plugins

✔️ Manage Databases*

✔️ JBMC Backward Compatible

* The Manage Databases Plugin is only available on JetBackup 5 for Linux.

Installed plugins are updated automatically via the JetBackup 5 Automated Task. There is no way to disable the auto-updates specifically for plugins as this helps ensure that any changes to the Base JetBackup version that may affect plugin functionality and/or features are up-to-date, and vice versa.

Quick actions:

Install

Install the selected available plugin.

Manage Plugin

Conveniently navigate to the selected plugin's interface.

Uninstall Plugin

Click on "Uninstall Plugin" to permanently remove your plugins. Make sure that the plugin is not in use in order to uninstall it.

Repositories

In the Repositories tab, you can add and manage Repositories that contains JetBackup plugins.

Available Repository actions:

Manage Repository

Click on "Manage Repository" to modify your repository configuration.

Reload Repository

Click on "Reload Repository"" to manually load your repository.

Delete Repository

Click on "Delete Repository" to remove your repository permanently. Make sure that no plugins are installed from the repository in order to delete it.

Create New Repository

To create a new repository, click on "+ Create New Repository".

Example configuration page for a repository:

Repository Name

Specify a unique name for your repository. This will be used internally for your convenience

Repository URL

Specify the URL for the repository where JetBackup will fetch available packages.

Jb5: addQueueItems

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

For the complete parameters available for this API call, please click HERE.

Parameter name	Type	Description	Possible values	Example
type	Integer	REQUIRED The Queue Group Type.	4: Download Queue	`type=4`
snapshot_id	String	REQUIRED The Parent ID of the Backup.	Find the Parent ID from the Backup Object.	`snapshot_id=607f602a47fdfc271457147a`
items	List []	REQUIRED When not using the snapshot_id. List of Backup Item Object IDs you would like to add to the restore queue.	The list of Backup Item Objects can be found when using getBackupItems.	`items[]=607f602a47fdfc271457147a`
files	List []	List of files/folders paths you want to download. This parameter is only available for file-based backups(homedir files).		`files[]=/public_html/index.html&files[]=/test.txt`

Example Call JETAPI

jetbackup5api -F addQueueItems -D "type=4&snapshot_id={$PARENT_ID_OF_BACKUP}"

jetbackup5api -F addQueueItems -D "type=4&items[0]{$BACKUP_ITEM_ID1}&items[1]={$BACKUP_ITEM_ID2}"

jetbackup5api -F addQueueItems -D "type=4&items[]={$BACKUP_ITEM_ID}&files[{$BACKUP_ITEM_ID}][PATH/TO/FILE/]"

success: 1
message: Items added to the queue 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: 6503ebd682762fb213093772
  owner: 6503eba4c6477f48c309376f
  owner_name: example
  created: 2023-09-15T05:29:58+00:00
  started: 2023-09-15T05:29:58+00:00
  ended:
  type: 4
  items: 1
  items_completed: 0
  finalize:
  status: 1
  can_rerun:
  rerun_failed:
  log_id: 6503ebd65f147c7ca3068012
  status_time: 2023-09-15T05:29:58+00:00
  progress:
    _id: 6503ebd682762fb213093774
    group_id: 6503ebd682762fb213093772
    item_id: 6503ebd682762fb213093773
    name:
    total: 0
    completed: 0
    subtotal: 0
    subcompleted: 0
    name_files:
    total_files: 0
    completed_files: 0
    percentage: 0
    percentage_sub: 0
    percentage_files: 0
  execution_time: 0
  actual_time: 0
  log_file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6503ebd682762fb213093772.log
  log_contents:
  data:
    account: example
    priority: 50

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=4&items[]={BACKUP_ITEM_ID1}&items[]={BACKUP_ITEM_ID2}

Jb5: addQueueItems

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

To Queue a Backup Job, please execute the runBackupJobManually API call. To Queue a Reindex for a Destination, please execute the reindexDestination API call.

Parameter name	Type	Description	Possible values	Example
type	Integer	REQUIRED The Queue Group Type.	1: Backup Queue 2: Restore Queue 4: Download Queue 8: Reindex Queue * incompatible with API command	`type=2`
snapshot_id	String	REQUIRED for Restore(2) or Download(4) Queue Types The Parent ID of the snapshot items.		`snapshot_id=607f602a47fdfc271457147a`
items	List []	Optional for Restore(2) or Download(4) Queue Types List of Backup Item Object IDs you would like to add to the queue.		`items[]=607f602a47fdfc271457147a`
options	List []	List of options you want to execute with the Queue Item(s). This parameter is only available for Restore Queue Type (2). For boolean type options, value is set to false by default.	terminate (boolean): true \| false suspend (boolean): true \| false merge (boolean): true \| false reseller (boolean): true \| false owner (string) package (string)	`options[merge]=true&options[owner]=root&options[package]=default`

Example Call JETAPI

jetbackup5api -F addQueueItems -D "type=2&snapshot_id={$PARENT_ID_OF_BACKUP}"

jetbackup5api -F addQueueItems -D "type=4&items[0]{$BACKUP_ITEM_ID1}&items[1]={$BACKUP_ITEM_ID2}"

jetbackup5api -F addQueueItems -D "type=2&items[]={$BACKUP_ITEM_ID}&files[{$BACKUP_ITEM_ID}][{/$FILE}]=File"

success: 1
message: Items added to the queue 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: 6503ebd682762fb213093772
  owner: 6503eba4c6477f48c309376f
  owner_name: example
  created: 2023-09-15T05:29:58+00:00
  started: 2023-09-15T05:29:58+00:00
  ended:
  type: 4
  items: 1
  items_completed: 0
  finalize:
  status: 1
  can_rerun:
  rerun_failed:
  log_id: 6503ebd65f147c7ca3068012
  status_time: 2023-09-15T05:29:58+00:00
  progress:
    _id: 6503ebd682762fb213093774
    group_id: 6503ebd682762fb213093772
    item_id: 6503ebd682762fb213093773
    name:
    total: 0
    completed: 0
    subtotal: 0
    subcompleted: 0
    name_files:
    total_files: 0
    completed_files: 0
    percentage: 0
    percentage_sub: 0
    percentage_files: 0
  execution_time: 0
  actual_time: 0
  log_file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6503ebd682762fb213093772.log
  log_contents:
  data:
    account: example
    priority: 50

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=4&snapshot_id={$PARENT_ID_OF_BACKUP}

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=4&items[0]={$BACKUP_ITEM_ID1}&items[1]={$BACKUP_ITEM_ID2}

Jb5: Backup Hook

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

Pre Backup Hook Args

**Pre Backup**
Argument Index	Value	Possible Values
$1	Backup Job ID
$2	Backup Job Name
$3	Backup Job Type	1 - Accounts 2 - Directories 3 - JB Config
$4	Backup Job Contains: Bitwise Value - Full Account: 511 = 1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256	1 - Account Panel Config 2 - Account Home Directory 4 - Account Databases 8 - Account Email 16 - Cron Jobs 32 - Accounts Domain 64 - Account Certificates 128 - Database Users 256 - FTP Accounts 511 - Full Account
$5	Backup Job Structure	1 - Incremental 2 - Archived 4 - Compressed
$6	Backup Job Destinations: All Destination IDs are seperated by a comma ,.
$7	Backup Start Date (EPOCH Time)
$8	Backup Log ID

Post Backup Hook Args

**Post Backup**
Argument Index	Value	Possible Values
$1	Backup Job ID
$2	Backup Job Name
$3	Backup Job Type	1 - Accounts 2 - Directories 3 - JB Config
$4	Backup Job Contains: Bitwise Value - Full Account: 511 = 1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256	1 - Account Panel Config 2 - Account Home Directory 4 - Account Databases 8 - Account Email 16 - Cron Jobs 32 - Accounts Domain 64 - Account Certificates 128 - Database Users 256 - FTP Accounts 511 - Full Account
$5	Backup Job Structure	1 - Incremental 2 - Archived 4 - Compressed
$6	Backup Job Destinations: All Destination IDs are seperated by a comma ,.
$7	Backup Start Date (EPOCH Time UTC)
$8	Backup End Date (EPOCH Time UTC)
$9	Backup Status (Queue Object Status)	1 - Pending 2 - Processing 100 - Completed 101 - Partially Completed 102 - Failed 103 - Aborted 104 - Never Finished
$10	Backup Log ID

Jb5: CreateAccount

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

**Parameters**
Parameter name	Type	Description	Possible values	Example
account	String	REQUIRED Username for the new Linux account.		`account=linuxUsername`

Example Call JETAPI

jetbackup5api -F Panel/CreateAccount -D "account={$USERNAME}"

success: 1
message: Account created successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/CreateAccount&account={$USERNAME}

Jb5: CreateAccount

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

**Parameters**
Parameter name	Type	Description	Possible values	Example
account	String	REQUIRED Username for the new Linux account.		`account=linuxUsername`

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/CreateAccount -D "account={$USERNAME}"

success: 1
message: Account created successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/CreateAccount&account={$USERNAME}

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

Jb5: Disaster Recovery Guide

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

For video tutorials, please click here:

Guide

Backups generated in v5.2.11 are not compatible in v5.3+. You will need to install v5.2.11 in order to complete a Disaster Recovery with those backups. Please follow the steps HERE to install v5.2.11.

JetBackup Config Backup Job

JetBackup 5 will backup it's internal databases only when JB Config is enabled on your configured backup destinations. In order to do so, click on “Export JB Config” on your preferred Destination. Keep your DR destination details and Master Encryption Key to be able to restore from DR.

Job Configuration

The JetBackup Config Backup Job is configured to be executed every night at 01:00 AM Server Time with a total schedule retention of 3. The JetBackup Config Backup Job is an Encrypted Compressed Backup that will dump the entire JetBackup MongoDB and Jetindexd Database in order to allow for Disaster Recovery.

Backup Structure: Compressed
Encrypted: True
Schedule: Daily - 01:00 AM Server Time
Retention: 3 Total Backups

Since the JetBackup Config Backup Job is encrypted, please make sure to keep a copy of your Master Encryption Key in a secure remote location. If the original server is lost, there is no other way to retrieve the Master Encryption Key. However, you may still install a Fresh JetBackup 5 instance and restore accounts using a Read-Only Destination. For more details see How to perform Disaster Recovery without Master Encryption Key?.

Disaster Recovery Best Practices

Consistent Environment Configurations

We recommend ensuring that the new environment you will be restoring to is similar to the source environment as much as possible to help limit incompatibilities between environments that may result in issues during restoration. This may include but is not limited to your Server Hardware (CPU, RAM, Hardrive), Operating System (distribution and version), web server (apache, Nginx, etc.), database (MySQL, PostgreSQL, MongoDB), Configurations and Settings, Addons and/or Extensions.

Perform Routine Recovery Testing

Testing your Disaster Recovery Plan regularly may help ensure that you have an effective and well-designed plan. Simulating Disaster Recovery scenarios may help identify potential points of failure in your current plan which can then be mitigated and/or addressed early on.

Upgrade/Migration Tips

When utilizing Disaster Recovery for Upgrade/Migration purposes, we highly recommend keeping the original server available for rollback until all accounts are restored and systems and features are verified to be functioning properly on the new server.

Recover from Disaster

Getting Started

JetBackup has the ability to restore from a disaster by storing our JetBackup internal database on your preferred destination. Performing a Disaster Recovery will restore the JetBackup Configuration that was backed up as well as give the option to restore all the accounts that have backups located on the configured destinations.

If for any reason you cannot perform a full Disaster Recovery, you can still restore your accounts manually from the destinations by following these instructions: How to perform Disaster Recovery without Master Encryption Key?

Important information before starting Disaster Recovery!

JetBackup will backup it's internal DB only when “Export JB Config” is enabled on your backup destination. In order to do so, click on "Export JB Config" on your preferred Destination. Keep your DR destination details to be able to restore from DR. The JB config backup will be executed every night and will keep a max of 3 snapshots.
Please make sure to keep your Master Encryption Key in a secure remote location.
There must be at least 1 User Package and/or Reseller Package (if applicable to your Panel) on the new server for JetBackup to assign the accounts to during a DR restore. Please ensure that you specify a “Default Package” in JetBackup's Panel Settings to use when the accounts backed up package is not found on the server.
The Disaster Recovery process is not intended for cross-panel migrations. Please take a look at the “Clone Jobs” feature, if you'd like to restore accounts across different control panels.
Restoring your JetBackup Configurations may take some time depending the number of backups indexed by JetBackup at the time the JB Config Export was generated. Please allow enough time for the JB Configurations Restore to complete to begin the Disaster Recovery process.

Initial Installation and Setup

With an entire data loss, your first step will be to install JetBackup on a supported platform that meets our system requirements. See Installation.

After Installation, you will be prompted to choose whether you want to Recover from Disaster, continue with existing data or start with a fresh install in the Disaster Recovery Wizard.

Choose "Recover from Disaster" to continue with disaster recovery.

Now, we need to restore JetBackup's internal database, so JetBackup will have all the information necessary to restore your accounts.

Please have the following information available for the next steps!

Destination Details and Backups Path for the destination where Export JB Config was enabled on your previous configuration. JetBackup will add this destination as a Read-Only Destination to pull your JetBackup Config information stored on that destination.
Master Encryption Key This encryption key is used to decrypt your JetBackup Config Backup and is REQUIRED to restore your previous JB configuration.

Restoring JB Configurations

The next step requires you to select your Destination Type. Any destination configured during Disaster Recovery will be added as a Read-Only Destination.

The "Local" destination is selected in the "Destination Type" dropdown by default. When restoring from a remote destination, the related destination plugin will need to be installed from the JetApps Repository first, and JetBackup will guide you through this process.

To restore JB Config, please select your destination from the "Destination Type" dropdown.

You will see the "Install Now" prompt when selecting a remote destination type.

Select "Install Now" to install the destination plugin.

Then enter the Destination details that you gathered earlier:

Choose the database backup (JetBackup settings) that you want to restore from (usually you will want the most recent backup that was created).

As our database is encrypted, you will need to specify the Master Encryption Key from your previous installation/server.

Enter the Master Encryption Key in the Encryption Key field:

If the key is valid, you will see the "Creating destination and reindexing JB configurations backups" after clicking "OK".

This may take some time to complete, depending on the size of your JetBackup database when the JB Config backup was generated and the number of snapshots.

Please do not exit or refresh the page while the JB Configurations restore is in progress.

Once completed, you will be able to restore your accounts from the destination.

(Optional) You can set "Delete orphan backups older than" option to "Disabled" in your JetBackup Settings to prevent orphan backups from being untentionally removed.

Restoring Accounts

Now we are ready to start restoring your accounts! Simply choose the accounts to restore through the Account Restore Filters and hit the "Finish & login to panel" to continue to your JetBackup Admin Panel while accounts are being restored in the background.

NOTE: JetBackup prioritizes restores by the account type out of the box. Along with the Queue Priority Groups setting, this ensures that parent accounts gets restored before their corresponding child accounts. For more Information regarding JetBackup 5's priority systems, please CLICK HERE.

Your accounts are now in the accounts restoration queue and may take some time to complete while the selected accounts are being restored. You can click "Finish and login to Panel", then visit the queue to check the status.

NOTE: The Disaster Recovery Wizard only lists backups from accounts that do not exist on the current server and were previously active on the source server when JetBackup generated the JB Config Backup.

Encrypted Backups

In order to restore an Encrypted Backup, it is REQUIRED to have both the JB Config and your Master Encryption Key. If the Master Encryption Key is missing, then the associated Encrypted Backups are PERMANENTLY lost in the event of a Disaster Recovery.

If a user has allowed Only Encrypted Backups, then their Encryption Key is stored locally on the server and will be tied to the JB Config. The user and admin will both be able to perform restores with the Encypted Backups.

The user can choose to store their key remotely where they will be shown the key once and be responisble for storing it in a safe place. The admin will not be able to perform any action on the Encrypted Backups. The user will have to perform restores on their end or provide the admin with the key so that they may perform it on the user's behalf.

NOTE: The JetBackup Config backup job runs daily at 1:00 AM server time. If performing a test, it MUST be after the JB Config job runs.

Post Disaster Recovery Checks

Re-Enable Export JB Config - Don't forget to re-enable "Export JB Config" on your preferred destinations! By default, all destinations will have the Export JB Config setting disabled post Disaster Recovery. You will need to re-enable them under Destination Settings.

Re-Enable Backup Jobs - Don't forget to re-enable your backup jobs! By default, backup jobs that are imported from your JB Config will be disabled. You will need to re-enable them under Backup Jobs.

Disabling Backup Jobs and Destinations on Original Server - In cases where you are migrating from a source server to a new server, please either make sure you uninstall JetBackup OR disable all Destinations and Backup Jobs on the source server to prevent potential conflicts with multiple instances of the same backup job running on 2 (or more) servers concurrently.

Jb5: getDashboardDetails

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

**returns**
Parameter name	Type	Description	Possible Values
statistics	Object	The Statistics Object from getStatistics.	total_new_alerts total_accounts total_backup_jobs total_backups total_disk_usage total_backup_jobs_running
alerts	List []	A list of the 3 most recent Alert Objects.	_id title message level created owner owner_name
queue	List []	A list of the most recent Queue Group Objects. (Max: 5)	_id owner owner_name created started ended type items items_completed finalize status log_id status_time execution_time actual_time log_file log_contents data
queue_summary	object	A compilation of different queue statuses.	pending processing completed failed
destinations	List []	A list of configured Destination Objects. (Max: 5)	_id name owner owner_name type count hidden readonly disabled disk_limit disk_usage update_date dr reindex running options
backup_jobs	List []	A list of configured Backup Job Objects. (Max: 5)	_id name destination destination_details type contains structure options state owner owner_name next_run last_run running disabled hidden time manually_retain exclude_list encrypted schedules hooks filters

Example Call JETAPI

jetbackup5api -F getDashboardDetails

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:
statistics:
total_new_alerts: 4
total_accounts: 4
total_backup_jobs: 3
total_clone_jobs: 0
total_backups: 1304
total_account_backups: 0
total_disk_usage: 8093958144
total_backup_jobs_running: 0
total_clone_jobs_running: 0
        alerts:
        0:
        _id: 6509fa687812ab761e0b2f42
        title: Restore for the account user completed successfully
        message: Restore process for the account user completed successfully in 11 Seconds
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T19:45:44+00:00
                status: 1
                created: 2023-09-19T19:45:44+00:00
                owner: 6503d48bfc45b1addf0a9636
                owner_name: user
                queue:
                groups:
                        0:
                _id: 6509fa5d381ecbc5a80b2f0e
                        owner: 6503d48bfc45b1addf0a9636
                        owner_name: user
                        created: 2023-09-19T19:45:33+00:00
                        started: 2023-09-19T19:45:33+00:00
                        ended: 2023-09-19T19:45:44+00:00
                        type: 2
                        items: 1
                        items_completed: 1
                        finalize:
                        status: 100
                        can_rerun:
                        rerun_failed:
                        log_id: 6509fa5d193c20350a0f7492
                        status_time: 2023-09-19T19:45:44+00:00
                        progress:
                        _id: 6509fa5d381ecbc5a80b2f10
                        group_id: 6509fa5d381ecbc5a80b2f0e
                        item_id: 6509fa5d381ecbc5a80b2f0f
                        name:
                        total: 1
                        completed: 0
                        subtotal: 1
                        subcompleted: 1
                        name_files:
                        total_files: 0
                        completed_files: 0
                        percentage: 0
                        percentage_sub: 100
                        percentage_files: 0
                        execution_time: 11
                        actual_time: 11
                        log_file: /usr/local/jetapps/var/log/jetbackup5/queue/2_6509fa5d381ecbc5a80b2f0e.log
                        log_contents:
                        data:
                        account: user
                        priority: 100010
                queue_summary:
                        pending: 0
                        processing: 0
                        completed: 1
                        failed: 1
                destinations:
                        destinations:
                        0:
                _id: 6503d9d5a31fb181bf02f682
                name: local
                owner: 6503d48bfc45b1addf0a9632
                owner_name: root
                type: Localv2
                job_type: 1
                count: 0
                hidden:
                readonly:
                disabled:
                disk_limit: 95
                disk_usage:
                usage: 39626219520
                free: 11674419200
                total: 51300638720
                threads: 10
                update_date: 2023-09-19T17:56:12+00:00
                dr: 1
                reindex:
                running:
                options:
                path: /backup2
                legacy:
                backup_jobs:
                        jobs:
                        0:
                _id: 6503d9d5a31fb181bf02f684
                name: JetBackup Config
                destination:
                0: 6503d9d5a31fb181bf02f682
                1: 6503eec8ebbf07708d06f1d2
                destination_details:
                0:
                        _id: 6503d9d5a31fb181bf02f682
                        name: local
                        owner: 6503d48bfc45b1addf0a9632
                        owner_name: root
                        type: Localv2
                        job_type: 1
                        count: 0
                        hidden:
                        readonly:
                        disabled:
                        disk_limit: 95
                        disk_usage:
                        usage: 39626219520
                        free: 11674419200
                        total: 51300638720
                        threads: 10
                        update_date: 2023-09-19T17:56:12+00:00
                        dr: 1
                        reindex:
                        running:
                        options:
                        path: /backup2
                        legacy:

Example Call HTTP

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

Jb5: getInfo

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

**returns**
Parameter name	Type	Description
utcOffset	String	The server's UTC Time Offset.
debug	Boolean	Value to determine if Debug Mode is enabled.
bod_disabled	Boolean	Value to determine Backup on Demand is disabled.
development	Boolean	Value to determine if Development is enabled.
process	Boolean	Value to determine if the JetBackup 5 Daemon is running.
sync_accounts	Boolean	Value to determine if JetBackup is currently syncing accounts from Panel.
messages	String	Standard messages for license status. (Default: null)

Example Call JETAPI

jetbackup5api -F getInfo

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:
utcOffset: -0700
debug:
bod_disabled: 1
development:
process: 1
sync_accounts:
messages:

Example Call HTTP

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

Jb5: getSettingsGeneral

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

**Returns**
Parameter name	Type	Description
installed	Boolean	Value to determine if JetBackup 5 is installed.
debug	Boolean	Value to determine if Debug Mode is enabled.
error_reporting	Boolean	Value to determine if Error Reporting is enabled.
workspace_path	String	The absolute path to the set Workspace.
downloads_path	String	The absolute path to the store Downloads.
orphan_backup_ttl	Integer	Value to determine the TTL of Orphan Backups.
logs_ttl	Integer	Value to determine the TTL of Logs
alerts_ttl	Integer	Value to determine the TTL of Alerts.
downloads_ttl	Integer	Value to determine the TTL of stored Downloads.
manually_backup_retain	Integer	Value to determine the retention of manual backups.
manually_backup_ttl	Integer	Value to determine the TTL of manual backups.
use_community_languages	Boolean	Use local translation files, or translation from our community languages CDN
show_damaged_backups	Boolean	Option to show damaged backups to end users
email_integration	String	Option to select Email notification integration
time_format	String	Select the preferred time format. Use "12" for 12-hour clock or "24" for 24-hour clock.

Example Call JETAPI

jetbackup5api -F getSettingsGeneral

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:
  installed: 1
  debug: 0
  error_reporting: 1
  workspace_path: /usr/local/jetapps/usr/jetbackup5/workspace
  downloads_path: /usr/local/jetapps/usr/jetbackup5/downloads
  orphan_backup_ttl: 180
  logs_ttl: 30
  alerts_ttl: 60
  downloads_ttl: 0
  manually_backup_retain: 14
  manually_backup_ttl: 0
  use_community_languages: 1
  email_integration: 65075381a8f98c6ea7022b64
  time_format: 12

Example Call HTTP

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

Jb5: getStatistics

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

**Returns**
Parameter name	Type	Description
total_new_alerts	Integer	Total number of new alerts in the past 24 hours.
total_accounts	Integer	Total number of accounts on the panel.
total_backup_jobs	Integer	Total number of Backup Jobs configured.
total_backups	Integer	Total number of Full Backups generated.
total_disk_usage	Integer	Total disk usage of all accounts (bytes).
total_backup_jobs_running	Integer	Total number of Backup Jobs currently running.

Example Call JETAPI

jetbackup5api -F getStatistics

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:
total_new_alerts: 4
total_accounts: 4
total_backup_jobs: 3
total_clone_jobs: 0
total_backups: 1304
total_account_backups: 0
total_disk_usage: 8093958144
total_backup_jobs_running: 0
total_clone_jobs_running: 0

Example Call HTTP

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

Jb5: listAlerts

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

Parameter name	Type	Description	Possible Values	Example
schedules	List []	List of all Alert Objects.
total	Integer	Total number of Alert Objects.

Example Call JETAPI

jetbackup5api -F listAlerts

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:
alerts:
        0:
        _id: 6508e8f223774d67a60f06db
        title: Reindex for the destination Local started
        message: Reindex process for the destination Local started
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:18:58+00:00
                status: 1
        created: 2023-09-19T00:18:58+00:00
        owner: 65075382d49adbd1660f06d2
        owner_name: root
        1:
        _id: 6508e8f223774d67a60f06dc
        title: Reindex for the destination Local completed successfully
        message: Reindex process for the destination Local successfully in less then a second
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:18:58+00:00
                status: 1
        created: 2023-09-19T00:18:58+00:00
        owner: 65075382d49adbd1660f06d2
        owner_name: root
        2:
        _id: 6508e9ae20b47525b50f06de
        title: Download for the account example started
        message: Download process for the account example started
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:22:06+00:00
                status: 1
        created: 2023-09-19T00:22:06+00:00
        owner: 6503eba4c6477f48c309376f
        owner_name: example
        3:
        _id: 6508e9be20b47525b50f0782
        title: Download for the account example completed successfully
        message: Download process for the account example completed successfully in 16 Seconds
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:22:22+00:00
                status: 1
        created: 2023-09-19T00:22:22+00:00
        owner: 6503eba4c6477f48c309376f
        owner_name: example
total: 4

Example Call HTTP

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

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

Jb5: listBackups

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

**Parameters**
Parameter name	Type	Description	Possible Values	Example
type	Integer	REQUIRED The Backup Type.	1 : Accounts 2 : Directories 3 : JB Config	`type=1`
contains	Integer	REQUIRED Integer value indicating the Backup Object Contains.	Please see the Backup Contains below for a all available contains values.	`contains=511`
account_id	String	REQUIRED Only for Backup Type Accounts. The Account ID whose backups you want to list. To list directory backups, you will replace the Account ID with the Backup Job ID.	See listAccounts to find the account_id. See listBackupJobs to find the Backup Job ID.	`account_id=60898b7f0510b07a0833d136`

Example Call JETAPI

jetbackup5api -F listBackups -D "type=1&contains=511&account_id={$ACCOUNT_ID}"
jetbackup5api -F listBackups -D "type=2&contains=3&account_id={$BACKUP_JOB_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:
backups:
        0:
        _id: 6503f05fedc7b9f4520a967a
        parent_id: 6503ef22edc7b9f4520a9643
        account_id: 6503d48bfc45b1addf0a9636
        destination: 6503eec8ebbf07708d06f1d2
        destination_name: s3
        name: user
        created: 2023-09-15T05:44:02+00:00
        path:
        backup_type: 1
        backup_contains: 511
        account: user
        account_data:
                _id: 6503d48bfc45b1addf0a9636
                username: user
                owner: root
                owner_id: 6503d48bfc45b1addf0a9632
                package: default
                suspended:
                reseller:
                root:
        size: 7813234243
        params:
        backup_structure: 1
        notes:
        location:
        safety:
        deleted:
        lock:
        lock_ttl:
        damaged:
        disabled:
        schedules:
                0: 8
        hidden:
        encrypted:
        encryption_id:
        encryption_key_required:
        encryption_key_exists: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listBackups&type=1&contains=511&account_id={$ACCOUNT_ID}

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

Jb5: ListDatabases

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

**Parameters**
Parameter name	Type	Description	Possible values	Example
type	Integer	Filter listed databases by type	MySQL: `type=1` MongoDB: `type=2` PostgreSQL: `type=3`	`type=1`

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of databases.
total	Integer	The total number of database.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/ListDatabases -D "type=1"

success: 1
message: List databases fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  databases:
    1:
      example:
      mysql: exampledb1
      sys:
    2:
    3:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/ListDatabases&type=1

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

Jb5: ListDatabaseUsers

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

**Parameters**
Parameter name	Type	Description	Possible values	Example
type	Integer	Filter listed databases by type	MySQL: `type=1` MongoDB: `type=2` PostgreSQL: `type=3`	`type=1`

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of database users.
total	Integer	The total number of database users.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/ListDatabaseUsers -D "type=1"

success: 1
message: List database users fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  users:
    1:
      example_user1: exampledb1
      example_user2: exampledb2
    2:
    3:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/ListDatabaseUsers&type=1

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

Jb5: listLogs

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

**Returns**
Parameter name	Type	Description	Possible Values	Example
logs	List []	List of all Log Objects.
sort	List[]	The value you want to sort by.	1 : ascending order -1 : descending order	`sort[start_time]=1` `sort[end_time]=-1` `sort[type]=1` `sort[status]=-1`
find	List[]	Find specific objects you want to filter.	Type Status info.Type info.Backup Job info.Destination info.ID	`find[Type]=1` `find[Status]=2` `find[info.Type]=Integrity Check / JB Config` `find[info.Backup Job]={$BACKUP_JOB_NAME}` `find[info.Destination]={$DESTINATION_NAME}` `find[info.ID]={$BACKUP_JOB_ID}`
skip	Integer	Skip the specified number of records returned.		`skip=100`
total	Integer	Total number of Log Objects.

Example Call JETAPI

jetbackup5api -F listLogs -D "find[type]=1&skip=100&find[info.ID]={$BACKUP_JOB_ID}&sort[start_time]=1"

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:
  logs:
        0:
          _id: 6508e8f1bd155427ab017ca5
          start_time: 2023-09-19T00:18:57+00:00
          end_time: 2023-09-19T00:18:58+00:00
          execution_time: 1
          actual_time: 0
          info:
                Destination: Local
          status: 1
          type: 5
          file: /usr/local/jetapps/var/log/jetbackup5/queue/8_6508e8f1d49adbd1660f06d6.log
          items: /usr/local/jetapps/var/log/jetbackup5/queue/8_6508e8f1d49adbd1660f06d6.items
        1:
          _id: 6508e9aee2238a334103e472
          start_time: 2023-09-19T00:22:06+00:00
          end_time: 2023-09-19T00:22:22+00:00
          execution_time: 16
          actual_time: 16
          info:
                Account: example
                Priority: 50
          status: 1
          type: 2
          file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.log
          items: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.items
        2:
          _id: 6508f21e2f624c95fe0f1c72
          start_time: 2023-09-19T00:58:06+00:00
          end_time: 2023-09-19T00:58:22+00:00
          execution_time: 16
          actual_time: 16
          info:
                Account: example
                Priority: 50
          status: 2
          type: 2
          file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508f21ed49adbd1660f06dc.log
          items: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508f21ed49adbd1660f06dc.items
  total: 3

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listLogs&find[type]=1&find[info.ID]={$BACKUP_JOB_ID}&sort[start_time]=1

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.
Please utilize the skip parameter if you wish to list items more than 100 records

Jb5: listPlugins

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

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

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.

Jb5: ListTokens

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

**Parameters**
Parameter name	Type	Description	Possible values	Example
filter	String	Filter generated access tokens by description, IP, or username.		`filter=My Description` `filter=127.0.0.1` `filter=linuxUsername`

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of access token items.	To view the parameters returned by this function, click on Token Object.
total	Integer	The total number of access token items.

Example Call JETAPI

jetbackup5api -F Panel/ListTokens -D "filter=example"

success: 1
message:
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  tokens:
    0:
      _id: 67a28e9bf5852b820503b792
      created: 2025-02-04T22:03:07+00:00
      last_access:
      last_access_ip:
      expiry: 0
      description: My Description 
      ip: 127.1.1.1
      username: example
    1:
      _id: 67a29072cf253c1c5207ee02
      created: 2025-02-04T22:10:58+00:00
      last_access:
      last_access_ip:
      expiry: 0
      description: My Description 2
      ip: 127.0.0.1
      username: example2
  total: 2

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/ListTokens&filter=example

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

Jb5: Local

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

For video tutorials, please click here:

Local(Legacy) & LocalV2

There are two local destination types that each use different backup formats.

Local(Legacy): This is a Rsync-Based destination type that stores your backups in a human-readable format and allows you to access the files directly in the destination.
LocalV2: This destination uses our Jetindex engine that is available in v5.3+. It utilizes the object storage format and stores the backups in JetBackup’s Propietary Backup structure which increases backup effiency and improves incremental functionality.

FUSE File Systems are known to have Rsync errors that can cause unstable backups to those partitions. Therefore, JetBackup cannot support Local Destinations to a FUSE File System. S3FS, Google Drive FUSE, and SSHFS are examples of these FUSE File Systems.

NOTE: When authenticating, JetBackup 5 will attempt to run a sequence of standard Linux Commands on the destination. Please review the common Linux commands and ensure the destination/user fully support these commands.

Creating the Destination

This guide shows how to add a Local backup destination to JetBackup.

Designate the Backup Directory for JetBackup to generate backups in and Save.

An example Local configuration page for the destination:

Destination Name

Specify a unique name for your destination. This will be used internally for your convenience.

Read Only

This option allows you to add the destination as a “Read Only” destination. You can only restore and download existing backups from a read-only destination. Read Only is required if the Backup Directory is already owned by another destination/server. This option is only selectable upon creating the destination and will be automatically enabled for any destinations added during a Disaster Recovery.

Owner

Specify the owner for this destination. This grants the owner and its parent account(s) permission to modify and delete this destination. Please note that the owner specified will also need Can Manage Destinations permission granted under the Permissions section.

Free Disk Space Limit

This option checks if the destination’s disk space has reached the specified limit before it executes the backup. When enabled, JetBackup will not perform the backup when the used disk space is over the specified limit. Select from the preset limits or input a custom disk space usage limit.

Maximum Concurrent Threads - (only available for localV2)

This option allows you to set the number of worker threads that can be used by the destination for upload/download/get/delete requests. This will be shared evenly across the number of Concurrent Tasks set for Backup or Restore/Download. As the tasks complete, the available threads will be allocated to the remaining active tasks up to the set limit. You can lower this value if you receive rate-limit errors from the remote destination.

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”.

For example: /PATH/TO/FOLDER.

Note: The absolute path must be unique and can not be used by two different Destination Configurations. If a backup directory is already owned by another JetBackup Destination, you may create a “Read Only” Destination to that path.

Please make sure that your destination path is secure and has the appropriate privileges. For more information click on How To Secure Backup Storage.

If you are setting up a local Destination pointing to a directory mounted with NFS, only NFSv3 and NFSv4.1 are supported. Please note that custom NFS/Mount configurations can cause issues with JetBackup. Due to the many custom NFS/mount configurations available, we only provide support for NFS v3 or v4.1 mounted with default options.

Rsync Bandwidth Limit

This option allows you to specify the maximum data transfer rate.

Jb5: manageAccount

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

Parameters

Parameter name	Type	Description	Example
_id	String	REQUIRED The Account ID.	`_id=6126745fb3086938ff643643`
email	String	The email used to notify the user after each user-initiated processes.
max_snapshots	Integer	The maximum snapshots allowed to create for the specified account.	`max_snapshots=5`
queue_priority	String	The ID of the queue priority to assign to the specified account.	`queue_priority=1`
tags	List []	List of Tag IDs to assign to the account	`tags[0]=64ee8eda75b29219cf697a82&tags[0]=64ee8ee3a4a9571ea9256162(Remove Tags): tags=`

Returns standard API Response data.

Example Call JETAPI

jetbackup5api -F manageAccount -D "_id={$ACCOUNT_ID}&email={$EMAIL}&max_snapshots={$VALUE}"

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

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageAccount&_id={$ACCOUNT_ID}&email={$EMAIL}&max_snapshots={$VALUE}

Jb5: manageAccountFilter

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

Parameter name	Type	Description	Possible Values	Example
action	String	REQUIRED on both create/modify. The action you want to perform	modify/create	`action=create`
type	Integer	REQUIRED/ONLY AVAILABLE on action create. The integer value for Account Filter Type.	Visit Account Filter Types below for all possible values.	`type=2`
name	String	REQUIRED on action create. The name given to your Account Filter for internal use.		`name=Account Filter 1`
condition	Integer	REQUIRED on action create. The Integer value to include or exclude chosen fields.	1 - Include 2 - Exclude	`condition=1`
list	List []	REQUIRED on action create. List of Account Usernames for Account Filter.	Visit listAccounts to find usernames of your accounts.	`list[0]=acct1&list[1]=acct2`
_id	String	REQUIRED on action modify. Account Filter ID is used for when you want to modify any of the Account Filter Object Fields.		`_id=5f864533cde674169f42ffe2`
owner	String	The Account Filter Owner's ID		`owner=670a937d1b620f5bbb0329a2`
usage	Integer	The Usage Limit for the Filter Type specific parameter assigned to the Account Filter. (Only for Filter Types 16 \| 32)	Type 16 - Usage Limit in Bytes Type 32 - Inode Usage Limit	`usage=4096`
range_start	String	The starting character for the range you want to filter by. (Only for Filter Type 128)	0-9_a-z	`range_start=0`
range_end	String	The ending character for the range you want to filter by. (Only for Filter Type 128)	0-9_a-z	`range_end=z`

To view the parameters returned, click on Account Filter Objects

Example Call JETAPI

jetbackup5api -F manageAccountFilter -D \
"action=create&\
type=2&\
name={$FILTER_NAME}&\
condition=1&\
list[0]={$ACCOUNT_NAME}&\
list[1]={$ACCOUNT_NAME}"

success: 1
message: Account Filter Created 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: 650b6ee8d8c76d2a42271352
group_id: 650b6ee8d8c76d2a42271353
type: 2
name: Account Filter 1
owner: 64f37d695aa01f55661b38f2
owner_name: root
count: 0
condition: 1
list:
        0: user

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageAccountFilter&action=create&type=2&name=Account Filter 1&condition=1&list[0]=acct1&list[1]=acct2

Jb5: manageCloneJob

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

Parameter name	Type	Description	Possible values	Example
action	String	REQUIRED Sets the flag to either create or modify.	create modify	`action=create`
_id	String	REQUIRED on action modify. The Clone Job ID.		`_id=5f8a7d0d348232507c4e7f02`
type	Integer	REQUIRED on action create. The Clone Type.	View all possible Clone Types below.	`type=1`
name	String	REQUIRED on action create. The name given to the Clone Job for internal use.		`name=Daily Clone`
destination	List []	REQUIRED on action create. List of the Destination IDs you will perform clones to. Must be a Clone Destination Type.		`destination[0]=5fcedb7e4caee42621624bc2`
contains	Integer	REQUIRED on action create. Value indicating what the backup contains.	View all possible Contains Values below.	`contains=511`
default_owner	String	The default owner you would like to set for your account for the Destination Server. If left blank, JetBackup will try to use the live owner.		`default_owner=root`
default_package	String	The default package you would like to set for your account for the Destination Server. If left blank, JetBackup will try to use the live package.		`default_package=user`
Owner	String	Owner of the Clone Job. The owner and his parent will have permissions to modify/delete this destination		`owner=admin`
monitor	List []	Set the values for the Clone Job Monitor. (0: disabled)	ranfor: (int) days notran: (int) days	`monitor[ranfor]=1&monitor[notran]=2`
Disabled	Boolean	Flag to know if a Clone Job is Disabled	1/0

Example Call JETAPI

jetbackup5api -F manageCloneJob -D \
"action=create&\
name=API Clone Job&\
owner={$OWNER_ACCOUNT_ID}&\
owner_name={$OWNER_ACCOUNT_NAME}&\
destination[0]={$DESTINATION_ID1}&\
type=1&\
contains=511&\
structure=1&\
filters[0][0]={$GROUP_FILTER_ID1}&\
filters[1][0]={$GROUP_FILTER_ID2}&\
filters[1][1]={$GROUP_FILTER_ID3}&\
exclude_list[0]=.MirrorSearch&\
exclude_list[1]=*/.wysiwygPro_*&\
exclude_list[2]=*/core.[0-9]*& \
schedules[0][_id]={$SCHEDULE_ID1}&\
schedules[0][retain]=5&\
schedules[1][_id]={$SCHEDULE_ID2}\
schedules[1][retain]=5&\
time=2330&\
monitor[ranfor]=1&\
monitor[notran]=1

success: 1
message: Clone Job Created Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: STABLE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 6505d2adf947d135e236c502
  name: clonetest
  destination:
    0: 6505d08d5cde724d10441b52
  destination_details:
    0:
      _id: 6505d08d5cde724d10441b52
      name: clone
      owner: 64f37d695aa01f55661b38f2
      owner_name: root
      type: Clones
      job_type: 2
      count: 1
      hidden:
      readonly:
      disabled:
      disk_limit: 95
      disk_usage:
      threads: 10
      update_date: 2023-09-16T15:58:08+00:00
      dr:
      reindex:
      running:
      options:
        password: JB|HIDDEN|********************
        privatekey:
        host:
        port:
        timeout: 60
        rsyncpreferip: 0
        rsyncbwlimit: 0
        internalprivatekey:
  type: 1
  contains: 511
  options: 0
  state: 0
  owner: 64f37d695aa01f55661b38f2
  owner_name: root
  next_run:
  last_run:
  running:
  disabled: 0
  time: 2000
  monitor:
    ranfor: 0
    notran: 0
  manually_retain: 0
  exclude_list:
  schedules:
  hooks:
  default_package:
  default_owner:
  suspend_after: 0
  filters:`

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageCloneJob&action=modify&type=1

Jb5: manageDestination

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

Parameter name	Type	Description	Possible values	Example
action	String	REQUIRED Flag to either create or modify the destination.	create modify	`action=create`
_id	String	REQUIRED for Modify Unique ID given to every Destination upon creation.		`_id=6140e800c6dcdd436e7cd362`
type	String	REQUIRED on action create. The Destination Type	Local JetStorage S3 SSH Clones GoogleDrive DropBox OneDrive FTP, SFTP Localv2	`type=SSH`
name	String	REQUIRED on action create. Custom destination name for your convenience.		`name=MyLocalDestination`
owner	String	Owner(ID) of the Destination. The owner and his parent will have permissions to modify/delete this destination	Owner will default to current logged-in user.	`owner=630e811f4ad52176890b3026`
disabled	Boolean	True if destination is Disabled		`disabled=0`
readonly	Boolean	Create the destination as a Read-Only Destination. Read Only destinations only allow restore/download of backups already stored on the destination. Existing Destinations cannot be edited to Read-Only.
dr	Boolean	Value indicating if the Destination is enabled for Export JB Config Backups.		`dr=1`
threads	Integer	Set the maximum concurrent threads that can be used by the destination for upload/download/get/delete requests.		`threads=100`
disk_limit	Integer	Sets the Disk Limit Percentage for the Destination.	0-100	`disk_limit=95`
hidden	Boolean
options	Object	REQUIRED on action create. Required options vary depending on destination type. Refer to Destination Options for more information.		`options[path]=/backups`
reindex	Boolean

Example Call JETAPI

jetbackup5api -F manageDestination -D "action=modify&_id={$DESTINATION_ID}&name={$NEWNAME}&disk_limit={disk_limit}"

jetbackup5api -F manageDestination -D "action=create&type=S3&name={$NAME}&threads=200&options[path]=/test&options[access_key]={$ACESS_KEY}&options[secret_key]={$SECRET_KEY}&options[bucket]={$BUCKET_NAME}&options[endpoint]={$REGION}.amazonaws.com&options[region]=us-west-1"

success: 1
message: Destination Created/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:
  name: s3-aws
  owner:
  owner_name: root
  type: S3
  job_type: 1
  count: 0
  hidden:
  readonly:
  disabled:
  disk_limit: 0
  disk_usage:
  threads: 10
  update_date: 2023-09-15T19:52:25+00:00
  dr:
  reindex: 1
  running:
  options:
    path: /test
    access_key:
    secret_key: JB|HIDDEN|********************
    region: us-west-1
    bucket: bucket
    endpoint: s3.us-west-1.amazonaws.com
  legacy:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageDestination&action=modify&_id={$DESTINATION_ID}&name={$NEWNAME}

Jb5: manageFilePermissions

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

Parameter name	Type	Description	Possible Values	Example
action	String	REQUIRED on both create/modify. The action you want to perform	modify create	`action=create`
regex	String	REQUIRED on action create. The regex for the File/Folder name you want the rule to apply to.		`regex=public_html`
_id	String	REQUIRED Filter Permissions ID of the Filter Permissions Object you are modifying		`_id=650a0e808df8a8d49500eac2`
Category	String	REQUIRED on action create. The category this File Permissions rule will be used for.	For a full list of available categories, please see the File Permissions Object below.	`category=1`
owner	String	Name of the owner you will like to assign.		`owner=root`
group	String	Name of the group you will like to assign.		`group=nobody`
recursive	Boolean	Boolean value to determine if the permissions rule will apply to all files/folders under the specified regex.		`recursive=1`
dirs_permissions	String	The permissions value you will like to give to directories.		`dirs_permissions=0755`
files_permissions	String	The permissions value you will like to give to files.		`files_permissions=0644`

Example Call JETAPI

jetbackup5api -F manageFilePermissions -D "action=create&regex=public_html&category=1&owner=example&group=nobody&recursive=1&dirs_permissions=0755&files_permissions=0644"

jetbackup5api -F manageFilePermissions -D "action=modify&_id={$FILE_PERMISSIONS_ID}&regex=public_html&category=1&owner=example&group=nobody&recursive=1&dirs_permissions=0755&files_permissions=0644"

success: 1
message: File Permissions Created/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: 650a0e808df8a8d49500eac2
  regex: public_html
  category: 1
  owner: example
  group: nobody
  recursive: 1
  dirs_permissions: 0755
  files_permissions: 0644

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageFilePermission&action=create&regex=public_html&category=1&owner=example&group=nobody&recursive=1&dirs_permissions=0755&files_permissions=0644

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageFilePermission&action=modify&_id={$FILE_PERMISSIONS_ID}&regex=public_html&category=1&owner=example&group=nobody&recursive=1&dirs_permissions=0755&files_permissions=0644

Jb5: manageHook

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

**Parameters**
Parameter name	Type	Description	Possible Values	Example
action	String	REQUIRED on both create/modify. The action you want to perform.	modify create	`action=create`
_id	String	REQUIRED on action modify. The ID of the Hook.		`_id=5f890a19e55cf262863522f2`
name	String	REQUIRED on action create. The name you will like to give your hook.		`name=exampleHook`
script	String	REQUIRED on action create. Path to the script file used for your hook. Must begin with /		`script=/PATH/TO/SCRIPT`
position_type	Integer	REQUIRED on action create. When the hook should run.	1 - pre 2 - post	`position_type=2`
position	Integer	REQUIRED on action create. The type of Hook you wish to run.	1 - Backup 2 - Restore 3 - Restore 4 - Download 5 - Reindex 8 - Backup Account 9 - Clone 10 - Clone Account	`position=1`
data_list	List []	List of data to pass to hook depending on position_type.	Backup - List of Backup Job IDs Restore - List of boolean value for Accounts Backup Download - List of boolean value for Accounts Backup Type Reindex - List of Destination IDs Backup Account - List of Backup Job IDs
disabled	Boolean	Boolean for is the Hook is disabled.	1 - true 0 - false	`disabled=1`

Example Call JETAPI

jetbackup5api -F manageHook -D "action=create&name=hookexample&script=/PATH/TO/SCRIPT&position_type=1&position=1"

jetbackup5api -F manageHook -D "action=modify&_id=6509273a7cc0fb810207f612&name=hookexample&position_type=1&position=1"

success: 1
message: Hook Created/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: 6509273a7cc0fb810207f612
  name: hookexample
  owner: 65075382d49adbd1660f06d2
  owner_name: root
  position_type: 1
  position: 1
  data_list:
  script: /PATH/TO/SCRIPT
  disabled:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageHook&action=create&name=examplehook&script=/PATH/TO/SCRIPT&position_type=1&position=1

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageHook&action=modify&_id=6509273a7cc0fb810207f612&name=hookexample&position_type=2&position=4

Jb5: managePermissions

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

**Parameters**
Parameter name	Type	Description	Possible Values	Example
username	String	Username of the acount you wish to change permissions.		`username=acct001`
permissions	List []	The permissions Key/Value pair you will be updating.	For a list of all permissions indexes and possible values, please visit Permissions Object below.	`permissions[0]=1&permissions[2]=2`

Example Call JETAPI

jetbackup5api -F managePermissions -D "username={$USERNAME}&permissions[0]=1&permissions[2]=2"

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

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=managePermissions&username={$USERNAME}&permissions[0]=1&permissions[2]=2

Jb5: manageRestoreCondition

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

Parameter name	Type	Description	Possible Values	Example
action	String	REQUIRED on both create/modify. The action you want to perform	modify create	`action=create`
condition	String	REQUIRED on both create/modify. The string of text for the user to agree.
_id	String	REQUIRED on action modify. Restore Condition ID is used for when you want to modify any of the Restore Condition Object Fields.		`type_data=5f864533cde674169f42ffe2`
disabled	Boolean	Boolean value to determine if the Restore Condition is disabled.	1 - true 0 - false	`disabled=1`

To view the parameters returned, click on Restore Condition Objects

Example Call JETAPI

jetbackup5api -F manageRestoreCondition -D "action=create&condition=Are you sure?"

jetbackup5api -F manageRestoreCondition -D "action=modify&_id={$RESTORE_CONDITION_ID}&condition=Are you sure?"

success: 1
message: Restore Condition Created/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: 650a09c88a71e8105406e6c2
  condition: Are you sure?
  disabled:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageRestoreCondition&action=create&condition=Are you sure?

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageRestoreCondition&action=modify&_id={$RESTORE_CONDITION_ID}&condition=Are you sure?

Jb5: manageSchedule

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

Parameter name Type Description Possible Values Example

action

String

REQUIRED on both create/modify. The action you want to perform.

modify
create

action=create

_id String REQUIRED on action modify. The ID of the schedule _id=5f890a19e55cf262863522f2

name String REQUIRED on action create. The Name of the schedule name=hourly schedule

type

Integer

REQUIRED on action create. The integer value for Schedule Type.

Hourly	1
Daily	2
Weekly	3
Monthly	4
After Backup Done	5

type=1

type_data[]* List REQUIRED on action create. For Schedule Types: Daily, Monthly Visit Type Data below for all possible values. type_data[0]=1&type_data[1]=2&...

type_data Integer REQUIRED on action create. For Schedule Types: Hourly, Weekly Visit Type Data below for all possible values. type_data=1

type_data String REQUIRED on action create. For Schedule Types: After Backup Job ID of the Backup Job you want to follow type_data=5f864533cde674169f42ffe2

delay_amount Integer Amount to delay by. Enter the amount as a positive integer. 0 amount will run the backup job immediately after the assigned job completes. delay_amount=0

delay_type

String

The Delay type for the schedule. Only for After Backup/Clone Jobs Done.

Minutes	1
Hours	2
Days	3

delay_type=1

Example Call JETAPI

jetbackup5api -F manageSchedule -D "action=create&name={$NAME}&jobs[0]={$BACKUP_JOB_ID}&type=2&type_data[0]=1&type_data[1]=2&type_data[2]=3&type_data[3]=4&type_data[4]=5&type_data[5]=6&type_data[6]=7"

success: 1
message: Schedule Created 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: 6505f00dea8aa76f3c0fe4a2
name: Daily 30 Retain
type: 2
type_name: Daily
type_data:
        0: 1
        1: 2
        2: 3
        3: 4
        4: 5
        5: 6
        6: 7
delay_type: 1
delay_amount: 0
delay: 0
owner: 6503d48bfc45b1addf0a9632
owner_name: root
count: 0
jobs:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSchedule&action=create&name={$NAME}&jobs[0]={$BACKUP_JOB_ID}&type=2&type_data[0]=1&type_data[1]=2&type_data[2]=3&type_data[3]=4&type_data[4]=5&type_data[5]=6&type_data[6]=7

Jb5: manageTag

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

Parameters

Parameter name	Type	Description	Possible values	Example
action	String	REQUIRED Flag to either create or modify the tag.	`create/modify`	`action=create`
_id	String	The tag ID. REQUIRED when modifying the tag.		`_id=6126745fb3086938ff643643`
type	boolean	The tag type. REQUIRED when creating the tag.	`1`	`type=1`
name	boolean	The tag name. REQUIRED when creating the tag.		`name=example1`
color	boolean	The tag color. REQUIRED when creating the tag.	Hexadecimal color value: `#RRGGBB`	`color=#7e2572`

Returns standard API Response data.

Example Call JETAPI

jetbackup5api -F manageTag -D "action=modify&_id={$TAG_ID}&name={$NAME}&color={$COLOR}"
jetbackup5api -F manageTag -D "action=create&name={$NAME}&color={$COLOR}&type=1"

success: 1
message: Tag Created/Updated Successfully
system:
  version: 5.3.14.4
  version_panel: 5.3.14.4
  tier: RELEASE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 67758a1170af6de0e006a8d2
  name: example1
  type: 1
  color: #7e2572
  owner: 675233ebeecc0e19bb0f5412
  owner_name: root

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageTag&action=modify&_id={$TAG_ID}&name={$NAME}&color={$COLOR}
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageTag&action=create&name={$NAME}&color={$COLOR}&type=1

Jb5: Notification Plugins

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

On top of email notifications, you also have the option to install and activate additional notification plugins to integrate with JetBackup, allowing you to send JetBackup notifications via other third-party messaging applications. Below is a list of notification plugins available by default and instructions on how to setup each.

NOTE: You can download jetbackup-eddie-512x512.png to use as an icon for notification integrations, if supported by the integration.

Natively Supported Notification Plugins:

Slack

Create a Slack App

Visit https://api.slack.com/apps and sign-in to your Slack Workspace to create a new app. Specify the name for your app and choose the Slack Workspace where the notification will be sent.

Under the "Features" section, click on "OAuth & Permissions" .

Scroll down to "Scopes: Bot Token Scopes", click on "Add an OAuth Scope" and apply the following permissions:

channles:read
channels:join
chat:write
groups:read

Click on "Install to Workspace" then authorize the permissions you have specified for the app.

Slack will then generate a "Bot User OAuth Access Token". Take note of this token as it will be required to authorize the Slack Plugin in JetBackup.

Private Slack Channels

If the notifications will be going to a private channel, there is one additional step to take in the Slack application.

Go into the channel's details.
Click on the Integrations tab.
Under the Apps box, click "Add an App".

Locate and add the app you created on the Slack API site.

Install and Activate the Slack Plugin

Once you have your Slack App configured, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

On the Slack Notification Plugin, click "Install" then hit "Activate"
On the Slack Notification Integration window, configure the following available options:
- Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
- Specify the Slack Channel Name you would like to receive the JetBackup notifications to.
- Enter the Bot User OAuth Access Token generated in your Slack App then hit "Enable".

JetBackup will then attempt to verify that the Slack Plugin is properly configured by sending a notification to the channel you specified on the plugin, and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Slack.

Syslog

Syslog is used for logging and tracking system messages in the Linux environment. This service constitutes the system log daemon (syslogd), where any program can do its logging in addition to kernel messages.

To Enable this plugin, navigate to Notification Settings (Settings > Notification). On the Syslog Notification Plugin, click "Install" then hit "Activate"

On the Slack Notification Integration window, configure the Notification Alert Levels and the frequency you would like to send your notifications to Slack then hit "Enable". For more information about alert types, please visit Alerts.

Once successfully activated, JetBackup will now be able to send notifications to /var/log/messages via syslog.

Configure a JetBackup Telegram Bot

Open your Telegram app and search for the user @BotFather. You can verify the correct user by looking for the blue checkmark next to the user's name.

Start a chat with the @BotFather and use the following command to begin the Create Bot Wizard: /newbot
- Insert the name for your bot.
- Insert the username for your bot.

NOTE: The username must be globally unique within Telegram. Per the Telegram documentation, Bot Names are publicly searchable and must be able to receive all messages, but not necessarily respond to them. Users that simply start a chat after it's already been configured or add the bot to a group will be unable to view the previous chat history. Alerts will only be sent to the configured chat ID set when creating the Notification Integration. For more information, please click here.

Once complete you should receive an HTTP API Token for your bot. Keep this token somewhere safe as it will be used to verify your bot.

NOTE: You may need to send a few messages in your new chat with the Telegram bot to update the bot data. Otherwise the activation method in the next step may fail. You can check the status of your Telegram bot by visiting [https://api.telegram.org/bot{HTTP_API_TOKEN}/getUpdates]{.title-ref} in your browser. There should be at least one entry of "chat": {"id"}.

Install and Activate the Telegram Plugin

Once you have your Telegram Bot configured and have the Bot API Token, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

On the Telegram Notification Plugin, click "Install" then hit "Activate"
On the Telegram Notification Integration window, configure the following available options:
- Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
- Enter the Bot Token generated in your Telegram APP then hit "Enable".

JetBackup will then attempt to verify that the Slack Plugin is properly configured by sending a notification to the chat you started with your bot and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Telegram.

Microsoft Teams

Register a Teams Apps with Microsoft Entra ID on Microsoft Graph

Visit https://portal.azure.com/#home and sign in with your Microsoft Account to create and register a new app for Microsoft Teams.
Navigate to "Microsoft Entra ID" by either clicking on the “View” button under the “Manage Microsoft Entra ID” at the home screen, or clicking “Microsoft Entra ID” at the expandable navigation bar on the left-hand side.

Once you’re in the “Microsoft Entra ID” page, navigate to “App registrations” and click on “+ New Registration”

Once on the App Registration page, fill in the following items:
- Name: the name that will be displayed when JetBackup sends notifications to Teams.
- Supported account types: Choose which account types can access your app.
  
  a. Accounts in this organizational directory only All user and guest accounts in your directory can use your application or API.
  b. Accounts in any organizational directory (Any Azure AD directory - Multitenant) All users with a work or school account from Microsoft can use your application or API. This includes schools and businesses that use Office 365.
  c. Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox All users with a work or school, or personal Microsoft account) can use your application or API. It includes schools and businesses that use Office 365 as well as personal accounts that are used to sign in to services like Xbox and Skype.
  
  Please use the account type that is most appropriate for your needs. For this example, we used option 3 to give the most open access for demo purposes.
- Redirect URI (required): the JetBackup notification plugin requires the Teams notification application to reach out to our Microsoft Teams authenticator. Select “Web” under application and set the following URI: https://auth.jetbackup.com/msteams/
- Click on Register

Once registered, you will be redirected back to your Application’s Overview page. Here you will be able to get an overview of your apps’ display name, Application ID, Directory ID, and other information that will be needed to connect your app to the JetBackup Notification plugin.

The next step is to set the required API permission to allow the JetBackup Notification plugin to communicate with your Teams App. From your application’s Overview Page, navigate to “API permissions” > “+ Add a permission”.

The Request API permissions window will pop up. Select “Microsoft Graph” > “Delegated permissions”, enable the following permissions then click “Add permissions”:
- Offline_access (Listed under "OpenId permissions")
- Channel.Create (Listed under "Channel")
- Channel.ReadBasic.All (Listed under "Channel")
- ChannelMessage.Send (Listed under "ChannelMessage")

The next step is to generate a Client Secret that your application will use as identification when requesting a token for authentication. Under the Application page, navigate to “Certificates & secrets” > “Client secrets” > “+ New client secret”. The “Add a client secret” window will pop up and you will be asked to specify a Description and how long the secret will take to expire then click Add.

Once added, take note of the Value and Secret ID. Please also note that you would need to generate a new client secret once it expires and update the Value on your JetBackup Teams Notification Plugin.

The next step is to provide admin consent to your application. First, navigate back to the “Azure Activity Directory” page then select “Enterprise applications” at the navigation bar. On the Enterprise applications page, you should see the app you just created. Click on your app then navigate to the “Permissions” page under Security. Click on the Grant admin consent button for your user to your application, select the appropriate account then click accept.

Once done, the application is ready to be set up in JetBackup 5.

Install and Activate the Microsoft Teams Plugin

Once you have your Microsoft Teams App configured, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).
On the Teams Notification Plugin, click "Install" then hit "Activate".
On the Teams Notification Integration window, configure the following available options:
- Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts
You will then be asked to specify the following items:
- Teams ID (Group ID): Can be found in the following interface: https://admin.teams.microsoft.com/teams/manage copy and use your Group ID.

-   Channel Name: The channel under your Team that you would like to receive notifications to
-   Client ID - Can be found on your Microsoft AD application Overview Page (Application (client ID))
-   Client Secret (Value generated on [Step 8 - Client Secret](#microsoft-teams))
-   Tenant ID (Can be found on your Microsoft AD Home Page)
-   Authorization Code (Once everything above is specified, click on "Get Authorization Code" and the JetBackup Teams Authorization Code Generator will pop up. Copy the code and paste it on this field.)
-   Hit \"**Save**\"

JetBackup will then attempt to verify that the TeamsPlugin is properly configured by sending a notification to the channel you specified on the plugin, and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through your Teams Channel.

Jb5: Addons Plugins

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

The Addons Plugins are plugins that provide extra functionality to the Core JetBackup features. Our showcase Addon Plugin is the Manage Databases plugin which is only available for JetBackup 5 for Linux installations. This plugin allows you to assign databases to Linux accounts in order to be included in Account Backups.

Natively Supported Addons Plugins:

Manage Databases

Configure Database Credentials

Navigate to JetBackup 5 -> Settings -> Panel to configure the login credentials for your MySQL, PostgreSQL, and/or MongoDB instances.

NOTE: Due to a known issue with MySQL and PHP on Debian/Ubuntu systems, if you are using localhost, you may need to use 127.0.0.1 instead. In order to successfully authenticate MySQL on Ubuntu, you need to ensure that the MySQL superuser used to authenticate only has superuser@127.0.0.1 and does not have superuser@localhost configured.

When establishing a connection to MongoDB, please input "admin" in the "Auth Database" field. This ensures that JetBackup uses the admin database.

You can also assign a Default Databases Backup Account. This account will "own" all Databases and Database users for Account Backups.

Install the Manage Databases Plugin

From the Plugins -> Available Plugins Page, install the Manage Databases Plugin.
After the installation is complete, navigate to the Installed Plugins tab to ensure the Plugin is Visible/Enabled.

Assigning Databases

The Manage Databases plugin will be set to automatically assign databases to accounts by default. Database names must start with username_ in order to be automatically assigned.

You can also change the Settings to manually assign databases to your Accounts.

From the Assign Databases tab, select the supported Database Engine and associated account you want to assign databases too.

If you observe that the Manage Database Plugin is unable to fetch Databases/Database Users, there may be an issue authenticating the Database Engine with the Credentials provided under the Databases Auth Panel Settings.

Please check the following FAQ/Troubleshooting entry for possible PostgreSQL authentication issues.

You will then be taken to the Assign Database for Account screen.
Select from the left hand side which Databases and Database Users you would like to assign to the selected Account.

NOTE: The selection of the "root" account is NOT supported. Instead, Jetbackup 5 recognizes a non-root Linux user as a valid account for assigning the databases and database users that you desire to backup.

After all Databases and Database users have been selected, press save.
Now an Account Backup of the assigned account will include the Databases and Database users it was assigned!

JBMC Backward Compatible

The JBMC Backward Compatible plugin is a supporting plugin for the JetBackup Management Console that allows communication between the registered JetBackup MC Sever and the Local JetBackup 5 Server. Please note, the JetBackup Management Console Register Feature handles the installation/configuraiton of the JBMC Backward Compatible plugin.

The JBMC Backward Compatible plugin page can be used to verify that the local JetBackup 5 Server is registered with a JetBackup Management Console.

Jb5: Backup Account Hook

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

Pre Backup Account Hook Args

**Pre Backup Account**
Argument Index	Value	Possible Values
$1	Backup Job ID
$2	Account ID
$3	Account User Name
$4	Backup Account Log ID

Post Backup Account Hook Args

**Post Backup Account**
Argument Index	Value	Possible Values
$1	Backup Job ID
$2	Account ID
$3	Account User Name
$4	Backup Account Status	1 - Completed 2 - Partially Completed 3 - Failed 4 - Aborted
$5	Backup Account Log ID
$6	Queue Object Status	100 - Completed 101 - Partially Completed 102 - Failed 103 - Aborted

Jb5: CheckConnection

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

**Returns**
Parameter name	Type	Description	Possible values	Example
registered	Integer	Returns the registered status.

Example Call JETAPI

jetbackup5api -F Plugin/JetBackupMC/CheckConnection

success: 1
message: Server is registered.
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  registered: 1

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/JetBackupMC/CheckConnection

Jb5: deleteSnapshot

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

Snapshot deletion must be enabled in order to use this API call. Please execute jetbackup5 --enable-delete-snapshot to enable it or jetbackup5 --disable-delete-snapshot to disable it.

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Snapshot ID to delete.		`_id=6126745fb3086938ff643643`

Example Call JETAPI

jetbackup5api -F deleteSnapshot -D "_id={$SNAPSHOT_ID}"

success: 1
message: Snapshot marked to deleted successfully
system:
  version: 5.3.16.0
  version_panel: 5.3.16.0
  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=deleteSnapshot&_id={$SNAPSHOT_ID}

Jb5: getAccount

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

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Account ID.		`_id=6126745fb3086938ff643643`

This API call returns account object. To view the parameters returned by this function, click on Account Object.

Example Call JETAPI

jetbackup5api -F getAccount -D "_id={$ACCOUNT_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: 6503e4ac6ea9d447360a963c
        uuid: 6fa109eba9dae3a36094e44674053f541bf9d89d
        username: user
        nickname:
        created: 2023-09-15T04:59:24+00:00
        domain: user.com
        owner: root
        owner_id: 6503d48bfc45b1addf0a9632
        owner_nickname: root
        owners:
                0: root
        owners_id:
                0: 6503d48bfc45b1addf0a9632
        homedir: /home/user
        ip:
        package: default
        packages:
        root:
        reseller:
        suspended:
        login_only:
        orphan:
        active: 1
        virtual:
        email:
        max_snapshots: -1
        backup_quota:
        backup_stats:
                511: 0
                1: 0
                2: 0
                4: 0
                128: 0
                256: 0
                8: 0
                16: 0
                32: 0
                64: 0
        tags:
        backup_type: 0
        encryption_key_type: 0
        privacy: 0
        queue_priority:
        last_active:
        secret_key:
        assignable_accounts: 1
        quota:
                disk_total: -1
                disk_usage: 1048576
                disk_free: -1
                inode_usage: 78

Example Call HTTP

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

Jb5: getAlert

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

**Returns**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Alert ID		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F getAlert -D "_id={$ALERT_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: 6508e8f223774d67a60f06db
  title: Reindex for the destination Local started
  message: Reindex process for the destination Local started
  level: 1
  send_logs:
        0:
          integration: Default Email Notification
          message: Successfully Sent
          created: 2023-09-19T00:18:58+00:00
          status: 1
  created: 2023-09-19T00:18:58+00:00
  owner: 65075382d49adbd1660f06d2
  owner_name: root

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getAlert&_id=5f890a19e55cf262863522f2

Jb5: getCloneJob

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

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Clone Job ID.		`_id=5f8a7d0d348232507c4e7f02`

Example Call JETAPI

jetbackup5api -F getCloneJob -D "_id={$CLONEJOB_ID}"

success: 1
message:
system:
version: 5.3.3
tier: STABLE
type: cPanel
drMode:
agreement:
licenseIssue:
data:
_id:
name:
destination:
destination_name:
time: 0
time_parsed: 12:00 AM
flag: 0
options: 0
monitor:
        ranfor: 0
        notran: 0
performance:
        lve:
        ionice: 1
        renice: 1
limitaccounts: 0
maximumruntime: 0
schedules:
filters:
pid: 0
progress:
excludelist:
time_estimation: 0
last_run:
next_run:
owner: root
disabled:
running:

Example Call HTTP

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

Jb5: getDestination

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

**Parameters**
Parameter name	Type	Description	Possible values	Example
_id	String	Required The ID of the destination.		`_id=5f7bdce1ae2dfb28835cb4e2`

This API Call returns a destination object.

To view the parameters returned, click on Destination Object.

Example Call JETAPI

jetbackup5api -F getDestination -D "_id={$DESTINATION_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: 6503eec8ebbf07708d06f1d2
name: s3
owner: 6503d48bfc45b1addf0a9632
owner_name: root
type: S3
job_type: 1
count: 1
hidden:
readonly:
disabled:
disk_limit: 0
disk_usage:
threads: 10
update_date: 2023-09-15T15:50:36+00:00
dr: 1
reindex:
running:
options:
        path: /test
        access_key:
        secret_key: JB|HIDDEN|********************
        region: us-west-1
        bucket: bucket
        endpoint: s3.us-west-1.amazonaws.com
legacy:

Example Call HTTP

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

Jb5: getDownload

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

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The Download Object ID.		`_id=5f7bdce1ae2dfb28835cb4e2`

Example Call JETAPI

jetbackup5api -F getDownload -D "_id={$DOWNLOAD_OBJECT_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: 6503ebe7effacb267509381e
  path: download_example_1694755815_10516.tar.gz
  full_path: /usr/local/jetapps/usr/jetbackup5/downloads/download_example_1694755815_10516.tar.gz
  size: 43589
  notes:
  backup_type: 1
  account: example
  account_name: example
  account_id: 6503eba4c6477f48c309376f
  items:
    0:
      _id: 6503ebb8ca4e13899d09378c
      name: example
      created: 2023-09-15T05:29:21+00:00
      backup_type: 1
      backup_contains: 1
    1:
      _id: 6503ebb8ca4e13899d09378d
      name: example
      created: 2023-09-15T05:29:21+00:00
      backup_type: 1
      backup_contains: 2
    2:
      _id: 6503ebb8ca4e13899d09378e
      name: example.com
      created: 2023-09-15T05:29:21+00:00
      backup_type: 1
      backup_contains: 32
    3:
      _id: 6503ebb8ca4e13899d09378f
      name: example.com
      created: 2023-09-15T05:29:21+00:00
      backup_type: 1
      backup_contains: 64
  created: 2023-09-15T05:30:15+00:00

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi??function=getDownload&_id=5f7bdce1ae2dfb28835cb4e2

Jb5: getFilePermissions

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

Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED File Permissions ID of the File Permissions Object		`_id=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F getFilePermissions -D "_id={$FILE_PERMISSIONS_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: 650a0e808df8a8d49500eac2
  regex: public_html
  category: 3
  owner: example2
  group: nobody2
  recursive:
  dirs_permissions: 0777
  files_permissions: 0444

Example Call HTTP

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

Jb5: getLog

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

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Log ID.		`_id=5f890a19e55cf262863522f2`
content	Boolean	Flag to print contents of requested log	1/0	`content=1`

Example Call JETAPI

jetbackup5api -F getLog -D "_id={$LOG_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: 6508e8f1bd155427ab017ca5
  start_time: 2023-09-19T00:18:57+00:00
  end_time: 2023-09-19T00:18:58+00:00
  execution_time: 1
  actual_time: 0
  info:
        Destination: Local
  status: 1
  type: 5
  file: /usr/local/jetapps/var/log/jetbackup5/queue/8_6508e8f1d49adbd1660f06d6.log
  items: /usr/local/jetapps/var/log/jetbackup5/queue/8_6508e8f1d49adbd1660f06d6.items

Example Call HTTP

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

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: getPermissions

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

**Parameters**
Parameter name	Type	Description	Possible Values	Example
username	String	Username of the acount you wish to change permissions.		`username=acct001`

Example Call JETAPI

jetbackup5api -F getPermissions -D "username={$USERNAME}

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:
  permissions:
        0: 1
        1: 0
        2: 2
        3: 2
        4: 2
        5: 2
        6: 2
        7: 2
        8: 2
        9: 2
        10: 2
        11: 2
        20: 2
        19: 2
        22: 2
        12: 2
        21: 2
        13: 2
        14: 2
        15: 2
        16: 2
        17: 2
        18: 2
        23: 2

Example Call HTTP

jetbackup5api -F getPermissions -D "username={$USERNAME}

Jb5: getQueueGroup

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

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the queue group object.		`_id=5b60448dd5ac5e4a877ac382`

Example Call JETAPI

jetbackup5api -F getQueueGroup -D "_id={$QUEUE_GROUP_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: 6508e9aed49adbd1660f06d9
owner: 6503eba4c6477f48c309376f
owner_name: example
created: 2023-09-19T00:22:06+00:00
started: 2023-09-19T00:22:06+00:00
ended: 2023-09-19T00:22:22+00:00
type: 4
items: 1
items_completed: 1
finalize:
status: 100
can_rerun:
rerun_failed:
log_id: 6508e9aee2238a334103e472
status_time: 2023-09-19T00:22:22+00:00
progress:
   _id: 6508e9aed49adbd1660f06db
   group_id: 6508e9aed49adbd1660f06d9
   item_id: 6508e9aed49adbd1660f06da
   name:
   total: 0
   completed: 0
   subtotal: 1
   subcompleted: 0
   name_files:
   total_files: 0
   completed_files: 0
   percentage: 0
   percentage_sub: 0
   percentage_files: 0
execution_time: 16
actual_time: 0
log_file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.log
log_contents:
data:
   account: example
   priority: 50

Example Call HTTP

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

Jb5: GetSettings

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

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns the plugin settings.

Example Call JETAPI

jetbackup5api -F Plugin/JetBackupMC/GetSettings

success: 1
message: Settings fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  mc_hostname: {Hostname/IP}:3032
  mc_token: q9aKPQ2fIUxX9ssf

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/JetBackupMC/GetSettings

Jb5: GetSettings

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

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns the plugin settings.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/GetSettings

success: 1
message: Settings fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  default_db_user:
  assign_type: 2

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/GetSettings

– JetBackup 5 Documentation

Jb5: A Guide to Upgrading to JetBackup 5

Benefits of the new JetBackup Core and Structure

Upgrade Preparations and Considerations

Getting Started

Installation Check

Importing Destinations

Importing Backup Jobs

Hooks

Settings

Post-Upgrade Recommendations

Uninstalling JetBackup 4

Updating from v5.2.11 to v5.3+

Jb5: Backup System Files

Backup Server Config Files/Directories

cPanel Include List

DirectAdmin Include List

Jb5: Backblaze Configurations

Create Backblaze Bucket

Create BackBlaze API Keys

Jb5: Overview

Create New Hook

Hook Name

Hook Position

Hook Type

Backup Hook

Backup Account Hook

Clone Hook

Clone Account Hook

Restore Hook

Download Hook

Reindex Hook

Hook Script

Hook Settings

Enable/Disable Hook

Manage Hook

Delete Hook

Jb5: Overview

Installed Plugins

Plugin actions:

Enable Plugin

Uninstall Plugin

Available Plugins

Quick actions:

Install

Manage Plugin

Uninstall Plugin

Repositories

Available Repository actions:

Manage Repository

Reload Repository

Delete Repository

Create New Repository

Repository Name

Repository URL

Jb5: addQueueItems

Jb5: addQueueItems

Jb5: Backup Hook

Pre Backup Hook Args

Post Backup Hook Args

Jb5: CreateAccount

Jb5: CreateAccount

Jb5: Disaster Recovery Guide

Guide

JetBackup Config Backup Job

Job Configuration

Disaster Recovery Best Practices

Consistent Environment Configurations

Perform Routine Recovery Testing

Upgrade/Migration Tips

Recover from Disaster

Getting Started

Initial Installation and Setup

Restoring JB Configurations

Restoring Accounts

Encrypted Backups

Post Disaster Recovery Checks

Jb5: getDashboardDetails

Jb5: getInfo

Jb5: getSettingsGeneral