JetBackup 5

https://docs.jetbackup.com/v5.3
Admin
JetBackup 5 is a comprehensive backup management system that enables users to create, schedule, and...
Tokens:240,719
Snippets:1,747
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Plugin via Package ID (HTTP)

Source: https://docs.jetbackup.com/v5.3/api/Plugins/installPlugin.html

This is an example of an HTTP GET request to install a plugin using its package ID. Replace hostname.example.com and cpsess########## with your actual details.

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

--------------------------------

### Install Plugin via Zip File (HTTP)

Source: https://docs.jetbackup.com/v5.3/api/Plugins/installPlugin.html

This is an example of an HTTP GET request to install a plugin using its compressed package filename. Replace hostname.example.com and cpsess########## with your actual details. The plugin zip file must be located in /usr/local/jetapps/tmp/jetbackup5/plugins/.

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

--------------------------------

### Create Repository using HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Plugins/manageRepository.html

This is an example of an HTTP GET request to create a repository. Replace placeholders with actual values.

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

--------------------------------

### getSettingsPanel Response (Panel)

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsPanel.html

This is an example of a successful response from the getSettingsPanel function for a panel-based JetBackup installation. It includes system information and default options for account management.

```json
success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel: 1
  agreement:
  licenseIssue:
data:
  options:
        default_owner: root
        default_ip:
```

--------------------------------

### List Plugins via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Plugins/listPlugins.html

This is an example of an HTTP GET request to list plugins. Ensure you replace 'hostname.example.com' with your actual server hostname and include the appropriate session ID.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listPlugins&filter=destination
```

--------------------------------

### getSettingsPanel Response (Panelless)

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsPanel.html

This example demonstrates a successful response from the getSettingsPanel function for a panelless JetBackup setup. It details system information and default settings for database management and authentication.

```json
success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
  data:
  options:
        default_db_user:
        assign_type: 1
        mysql_enabled: 0
        mysql_user: root
        mysql_password:
        mysql_host: localhost
        mysql_port: 3306
        mysql_socket:
        pg_enabled: 0
        pg_user:
        pg_password:
        pg_host: localhost
        pg_port:
        mongodb_enabled: 0
        mongodb_user:
        mongodb_password:
        mongodb_host: localhost
        mongodb_port: 27017
        mongodb_auth_db:
```

--------------------------------

### ManageSettings API HTTP Request Example

Source: https://docs.jetbackup.com/v5.3/api/PluginAPI/JetBackupMC/ManageSettings.html

This is an example of how to call the ManageSettings function using an HTTP GET request. Replace HOST_NAME, {$HOSTNAME}, and {$MC_TOKEN} with your specific environment details.

```http
https://HOST_NAME:3035/?api=1&function=Plugin/JetBackupMC/ManageSettings&mc_hostname={$HOSTNAME}&mc_token={$MC_TOKEN}
```

--------------------------------

### HTTP Call to Get General Settings

Source: https://docs.jetbackup.com/v5.3/api/Settings/GetSettingsGeneral.html

This is an example of an HTTP GET request to retrieve general settings using the JetBackup 5 API. Replace 'hostname.example.com' with your actual server hostname.

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

--------------------------------

### Manage Plugin via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Plugins/managePlugin.html

This is an example of an HTTP GET request to manage plugin settings. Replace 'hostname.example.com' with your actual server hostname and ensure the session ID is valid.

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

```

--------------------------------

### List Repositories via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Plugins/listRepositories.html

This is an example of an HTTP GET request to list repositories. Ensure you replace 'hostname.example.com' with your actual server hostname and include the correct session identifier.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listRepositories&filter='JetApps Repository'
```

--------------------------------

### Plugin Installation Response

Source: https://docs.jetbackup.com/v5.3/api/Plugins/installPlugin.html

This is a sample success response after a plugin has been successfully installed. It includes system information and details about the installed plugin.

```json
{
  "success": 1,
  "message": "Plugin Installed Successfully",
  "system": {
    "version": "5.3.3",
    "version_panel": "5.3.3",
    "tier": "EDGE",
    "type": "cPanel",
    "retry_ms": 0,
    "disableui": null,
    "dr": null,
    "agreement_panel": null,
    "agreement": null,
    "licenseIssue": null
  },
  "data": {
    "_id": "65092deda67f7fafca057242",
    "code": "JetBackupMC",
    "name": "JBMC Backward Compatible Plugin",
    "description": "Supporting plugin that allows the push of JetBackup 5 Data to the registered JetBackup MC Instance.",
    "icon": "fas fa-star",
    "version": "1.1.0",
    "type": "addon",
    "author": "JetApps",
    "permissions": 1,
    "experimental": "JetApps does not guarantee the error-free functionality of experimental features, and we provide it on an experimental basis only. You assume all risk for any function that you use marked \"Experimental\". Installation of this software could cause functionality failures, even for experienced administrators. Eventually this function will be released to our STABLE tier, once adequate testing and refinement is completed.",
    "repo": "6507537fa8f98c6ea7022b52",
    "options": null,
    "repo_name": "JetApps Repository",
    "disabled": 1,
    "visible": null,
    "available_package": null
  }
}
```

--------------------------------

### Install JetApps Package

Source: https://docs.jetbackup.com/v5.3/adminpanel/commandLineTools.html

Install a JetBackup package by specifying its name and tier using the -s or --install flag.

```bash
-s {package} {tier} / --install {package} {tier}

```

--------------------------------

### Install JetBackup 5 for cPanel

Source: https://docs.jetbackup.com/v5.3/adminpanel/generalInformation.html

Use this command to install JetBackup 5 on a server with cPanel. This command should be executed after the JetApps repository has been installed.

```bash
jetapps --install jetbackup5-cpanel release
```

--------------------------------

### HTTP Request to Manage General Settings

Source: https://docs.jetbackup.com/v5.3/api/Settings/ManageSettingsGeneral.html

This is an example of an HTTP GET request to the JetBackup 5 API for managing general settings. Ensure you replace placeholders like 'hostname.example.com' and session IDs.

```http
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsGeneral&manually_backup_retain=10&manually_backup_ttl=15&debug=1
```

--------------------------------

### Install JetBackup 5 for DirectAdmin

Source: https://docs.jetbackup.com/v5.3/adminpanel/generalInformation.html

Use this command to install JetBackup 5 on a server with DirectAdmin. This command should be executed after the JetApps repository has been installed.

```bash
jetapps --install jetbackup5-directadmin release
```

--------------------------------

### Install JetBackup 5 for InterWorx

Source: https://docs.jetbackup.com/v5.3/adminpanel/generalInformation.html

Use this command to install JetBackup 5 on a server with InterWorx. This command should be executed after the JetApps repository has been installed.

```bash
jetapps --install jetbackup5-interworx release
```

--------------------------------

### List Queue Items using HTTP

Source: https://docs.jetbackup.com/v5.3/api/Queues/ListQueueItems.html

This is an example of an HTTP GET request to list queue items. Replace 'hostname.example.com' and 'cpsess##########' with your actual server details. The group_id parameter should be dynamically inserted.

```http
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listQueueItems&group_id={$QUEUE_GROUP_ID}
```

--------------------------------

### List Downloads using HTTP API Call

Source: https://docs.jetbackup.com/v5.3/api/Downloads/listDownloads.html

Example HTTP GET request to the JetBackup API endpoint for listing downloads. Ensure to replace 'hostname.example.com' and session details with your actual values.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi??function=listDownloads
```

--------------------------------

### List Log Items via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Logs/listLogItems.html

This is an example of an HTTP GET request to list log items. Replace 'hostname.example.com' with your server's hostname and ensure the session ID is valid.

```http
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listLogItems&log_id={$LOG_ID}
```

--------------------------------

### Install JetBackup 5 for Plesk

Source: https://docs.jetbackup.com/v5.3/adminpanel/generalInformation.html

Use this command to install JetBackup 5 on a server with Plesk. This command should be executed after the JetApps repository has been installed.

```bash
jetapps --install jetbackup5-plesk release
```

--------------------------------

### Get Destination using HTTP

Source: https://docs.jetbackup.com/v5.3/api/Destinations/getDestination.html

This is an example of an HTTP GET request to retrieve destination details. Ensure you replace 'hostname.example.com' and include the correct session identifier and destination ID.

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

--------------------------------

### Install JetBackup 5 for Linux (Panelless)

Source: https://docs.jetbackup.com/v5.3/adminpanel/generalInformation.html

Use this command to install JetBackup 5 on a panelless Linux environment. This command should be executed after the JetApps repository has been installed.

```bash
jetapps --install jetbackup5-linux release
```

--------------------------------

### HTTP GET Request for getCloneJob

Source: https://docs.jetbackup.com/v5.3/api/CloneJobs/getCloneJob.html

This is an example of how to call the getCloneJob function using an HTTP GET request. Ensure you replace hostname.example.com and the session ID with your actual details, and {$CLONEJOB_ID} with the target clone job's ID.

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

--------------------------------

### Modify Repository using HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Plugins/manageRepository.html

This is an example of an HTTP GET request to modify an existing repository. The repository ID is required.

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

--------------------------------

### List Backups (CLI Example)

Source: https://docs.jetbackup.com/v5.3/api

This command-line interface example shows how to list backups using the jetbackup5api tool. It specifies the function and provides parameters for filtering.

```APIDOC
## listBackups (CLI)

### Description
This command uses the jetbackup5api CLI tool to list backups. The `-D` option allows passing parameters to filter the backup list.

### Method
CLI Command

### Endpoint
N/A (CLI Tool)

### Parameters
#### Command Line Arguments
- **backup** - The command to list backups.
- **-F listBackups** - Specifies the function to execute.
- **-D "type=127"** - Data parameter to filter backups by type.

### Request Example
```bash
jetbackup5api backup -F listBackups -D "type=127"
```

### Response
Refer to the general API response structure. The `data` field will contain the list of backups.
```

--------------------------------

### Modify Clone Job with HTTP

Source: https://docs.jetbackup.com/v5.3/api/CloneJobs/manageCloneJob.html

This is an example of how to modify an existing clone job using an HTTP GET request. The 'action=modify' parameter is crucial for this operation.

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

--------------------------------

### Call getSettingsExtension via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsExtension.html

This is an example of how to call the getSettingsExtension function using an HTTP request. Replace 'hostname.example.com' with your actual server hostname and ensure the correct port and session ID are used.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getSettingsExtension

```

--------------------------------

### Approve Agreement via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/System/approveAgreement.html

This is an example of an HTTP GET request to approve the JetBackup EULA. Replace 'hostname.example.com' and 'cpsess##########' with your actual server details.

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

--------------------------------

### Call manageSettingsGeneral via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsPerformance.html

This example demonstrates how to call the manageSettingsGeneral API endpoint using an HTTP GET request. Note that this is for managing settings, not retrieving them.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsGeneral&manually_backup_retain=10&manually_backup_ttl=15&debug=1
```

--------------------------------

### Example getInfo Response

Source: https://docs.jetbackup.com/v5.3/api/Dashboard/getinfo.html

This is a sample response structure from the getInfo function, detailing various system parameters and their current values.

```json
__
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:
```

--------------------------------

### Call listShowcase via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Dashboard/listShowcase.html

This is an example of how to call the listShowcase function using an HTTP GET request. Replace 'hostname.example.com' and 'cpsess##########' with your actual server details.

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

--------------------------------

### Create or Modify Tag via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Accounts/manageTag.html

These are example HTTP GET requests to manage account tags. Replace 'hostname.example.com' and other placeholders with your specific details.

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

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

--------------------------------

### Example Response for getSettingsPerformance

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsPerformance.html

This is an example of the JSON response received when calling getSettingsPerformance. It details various performance-related settings.

```json
__
success: 1
message: General Settings Updated Successfully.
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  installed: 1
  debug: 1
  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: 10
  manually_backup_ttl: 15
  use_community_languages: 1
  email_integration: 65075381a8f98c6ea7022b64
  time_format: 12
```

--------------------------------

### Approve Showcase via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/System/approveShowcase.html

This is an example of an HTTP GET request to approve a showcase modal. Replace 'hostname.example.com' and session details with your actual server information.

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

--------------------------------

### HTTP API Call to Manage Restore Settings

Source: https://docs.jetbackup.com/v5.3/api/Settings/manageSettingsRestore.html

This is an example of how to call the manageSettingsRestore function using an HTTP GET request. Ensure you replace hostname and session details.

```http
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsRestore&limit_times=3&limit_hours=1&package_selection=2&lock_homedir=0
```

--------------------------------

### Install BitNinja with License Key

Source: https://docs.jetbackup.com/v5.3/adminpanel/security.html

Install BitNinja on your Linux server by executing this command in your server's terminal, replacing the placeholder with your actual license key.

```bash
curl https://get.bitninja.io/install.sh | sudo /bin/bash -s - --license_key=<License Key Here>
```

--------------------------------

### List Tokens with Filter (HTTP)

Source: https://docs.jetbackup.com/v5.3/api/PanelAPI/ListTokens.html

This is an example of an HTTP GET request to list access tokens, including a filter parameter. Replace HOST_NAME with your server's hostname.

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

--------------------------------

### Add Multiple Account Queue Items via JETAPI

Source: https://docs.jetbackup.com/v5.3/api/Queues/addMultiAccountQueueItems.html

This example demonstrates how to use the JETAPI command-line tool to add multiple account queue items for download.

```bash
__
jetbackup5api -F addMultiAccountQueueItems -D "type=4&backup_contains=1&filters[listAccountsByFilters]=0&filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0&options[allbackups]=0&options[suspend]=0"
```

--------------------------------

### Example Response for getSettingsExtension

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsExtension.html

This is a sample response structure when calling the getSettingsExtension function. It details the system version, tier, type, and the configured data for vendors, excludes, and partner token.

```json
__
success: 1
message: 
system:
  version: 5.3.18.0
  version_panel: 5.3.18.0
  tier: ALPHA
  type: cPanel
  retry_ms: 0
  disableui: 
  dr: 
  agreement_panel: 
  agreement: 
  licenseIssue: 
data:
  vendors: 
    0: WPToolkit
    1: Softaculous
  excludes: 
    0: *.com/*
    1: domain.com/*
  partner_token: 
```

--------------------------------

### Call getDownload via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Downloads/getDownload.html

This is an example of how to call the getDownload function using an HTTP GET request. Ensure you replace 'hostname.example.com' and the session ID with your actual values.

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

--------------------------------

### Manage Account via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Accounts/manageAccount.html

This is an example of how to call the manageAccount function using an HTTP GET request. Ensure you replace 'hostname.example.com' and other placeholders with your specific details.

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

--------------------------------

### Update Performance Settings via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/Settings/manageSettingsPerformance.html

This is an example of an HTTP GET request to update performance settings. Ensure you replace 'hostname.example.com' and 'cpsess##########' with your actual server details.

```http
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsPerformance&backup_forks=5&limit_account_downloads=10
```

--------------------------------

### Call listAccountPackages via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Accounts/listAccountPackages.html

Make an HTTP GET request to the specified URL to list account packages. Ensure to replace 'hostname.example.com' and include session details.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccountPackages&all=1
```

--------------------------------

### Call JETAPI CLI to Get Settings Privacy

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsPrivacy.html

Use this command to retrieve the privacy settings via the JETAPI command-line interface. Ensure you have the JETAPI tool installed and configured.

```bash
__
jetbackup5api -F getSettingsPrivacy
```

--------------------------------

### Backup Account with pkgacct

Source: https://docs.jetbackup.com/v5.3/adminpanel/commandLineTools.html

Create a local backup of a user account in a .tar.gz format. Specify the account username as a required argument. Use -oSkip to exclude specific data.

```bash
/usr/bin/jetbackup5 --pkgacct {ACCOUNT} [options]

```

```bash
jetbackup5 --pkgacct user1

```

```bash
-oSkip config,homedir

```

--------------------------------

### Run Extension Deployment via HTTP

Source: https://docs.jetbackup.com/v5.3/api/Settings/runExtensionDeployment.html

This is the URL structure for making an HTTP request to trigger the extension deployment. Replace 'hostname.example.com' and session details with your actual server information.

```http
__
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=runExtensionDeployment

```

--------------------------------

### Create Schedule via HTTP API

Source: https://docs.jetbackup.com/v5.3/api/Schedules/manageSchedule.html

This is an example of how to create a schedule using an HTTP GET request to the JetBackup API. Replace placeholders with your actual hostname and session ID.

```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

```

--------------------------------

### Add Queue Items - HTTP Example 1

Source: https://docs.jetbackup.com/v5.3/api/Queues/addQueueItems.html

Example of queuing a restore job for a full account using HTTP.

```APIDOC
## addQueueItems

### Description
This function lets you Queue Backup Items for restore or download.
To Queue a Backup Job, please execute the runBackupJobManually API call. To Queue a Reindex for a Destination, please execute the reindexDestination API call.

### Method
HTTP

### Endpoint
`https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi`

### Parameters
#### Query Parameters
- **function** (String) - REQUIRED - Specifies the API function to call, which is `addQueueItems`.
- **type** (Integer) - REQUIRED - The Queue Group Type. Possible values: 1 (Backup Queue), 2 (Restore Queue), 4 (Download Queue), 8 (Reindex Queue).
- **snapshot_id** (String) - REQUIRED for Restore(2) or Download(4) Queue Types - The Parent ID of the snapshot items.
- **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.
- **options** (List []) - List of options for Queue Item(s). Only available for Restore Queue Type (2). Options include: terminate (boolean), suspend (boolean), merge (boolean), reseller (boolean), owner (string), package (string).

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

### Response
#### Success Response
- **success** (Integer) - Indicates success (1 for success).
- **message** (String) - A message confirming the action.
- **data** (Object) - Contains details about the queued item.

#### Response Example
```json
{
  "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": null,
    "dr": null,
    "agreement_panel": null,
    "agreement": null,
    "licenseIssue": null
  },
  "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": null,
    "type": 4,
    "items": 1,
    "items_completed": 0,
    "finalize": null,
    "status": 1,
    "can_rerun": null,
    "rerun_failed": null,
    "log_id": "6503ebd65f147c7ca3068012",
    "status_time": "2023-09-15T05:29:58+00:00",
    "progress": {
      "_id": "6503ebd682762fb213093774",
      "group_id": "6503ebd682762fb213093772",
      "item_id": "6503ebd682762fb213093773",
      "name": null,
      "total": 0,
      "completed": 0,
      "subtotal": 0,
      "subcompleted": 0,
      "name_files": null,
      "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": null,
    "data": {
      "account": "example",
      "priority": 50
    }
  }
}
```
```

--------------------------------

### Download and Run JetBackup 4 to 5 Import Tool

Source: https://docs.jetbackup.com/v5.3/adminpanel/Resources/migrationguide.html

Execute this command to download, unzip, and run the import tool for migrating settings from JetBackup 4 to JetBackup 5. Ensure you are in your home directory before running.

```bash
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
```

--------------------------------

### List MySQL Databases via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/PluginAPI/ManageDatabases/ListDatabases.html

This is an example of an HTTP GET request to list MySQL databases. Replace HOST_NAME with your server's hostname or IP address.

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

```

--------------------------------

### Create or Modify a Backup Job

Source: https://docs.jetbackup.com/v5.3/api/BackupJobs/manageBackupJob.html

Use this example to create a new backup job or modify an existing one by specifying the action and relevant parameters. Ensure all required parameters for the chosen action are included.

```bash
__
jetbackup5api -F manageBackupJob -D \
  "action=create&\
  name=API Backup Job&\
  owner={$OWNER_ACCOUNT_ID}&\
  owner_name={$OWNER_ACCOUNT_NAME}&\
  destination[0]={$DESTINATION_ID1}&\
  destination[1]={$DESTINATION_ID2}&\
  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"
```

--------------------------------

### getSettingsBinary

Source: https://docs.jetbackup.com/v5.3/api/Settings/getSettingsBinary.html

Fetches the absolute paths of system binaries used by JetBackup.

```APIDOC
## getSettingsBinary

### Description
This function prints the objects data given its Settings Binary Object. It returns the absolute paths for various system binaries.

### Method
GET

### Endpoint
/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getSettingsBinary

### Response
#### Success Response (200)
- **rsync** (String) - Absolute path to the binary for rsync.
- **psql** (String) - Absolute path to the binary for psql.
- **pgrestore** (String) - Absolute path to the binary for pgrestore.
- **pgdump** (String) - Absolute path to the binary for pgdump.
- **mysql** (String) - Absolute path to the binary for mysql.
- **mysqldump** (String) - Absolute path to the binary for mysqldump.
- **ionice** (String) - Absolute path to the binary for ionice.
- **tar** (String) - Absolute path to the binary for tar.
- **gzip** (String) - Absolute path to the binary for gzip.
- **gunzip** (String) - Absolute path to the binary for gunzip.
- **mongodump** (String) - Absolute path to the binary for mongodump.
- **mongorestore** (String) - Absolute path to the binary for mongorestore.

#### Response Example
```json
{
  "success": 1,
  "message": null,
  "system": {
    "version": "5.3.3",
    "version_panel": "5.3.3",
    "tier": "EDGE",
    "type": "cPanel",
    "retry_ms": 0,
    "disableui": null,
    "dr": null,
    "agreement_panel": null,
    "agreement": null,
    "licenseIssue": null
  },
  "data": {
    "rsync": "/usr/local/jetapps/usr/bin/rsync",
    "rear": "/usr/local/jetapps/usr/bin/rear",
    "psql": "psql",
    "pgrestore": "pg_restore",
    "pgdump": "pg_dump",
    "mysql": "mysql",
    "mysqldump": "mysqldump",
    "ionice": "ionice",
    "tar": "tar",
    "gzip": "gzip",
    "gunzip": "gunzip",
    "mongodump": "/usr/local/jetapps/usr/bin/mongodump",
    "mongorestore": "/usr/local/jetapps/usr/bin/mongorestore"
  }
}
```
```

--------------------------------

### Create User Session via HTTP Request

Source: https://docs.jetbackup.com/v5.3/api/PanelAPI/CreateUserSession.html

This is an example of an HTTP GET request to create a user session. Ensure to replace HOST_NAME and {$USERNAME} with your actual host and username.

```http
__
https://HOST_NAME:3035/?api=1&function=Panel/CreateUserSession&user={$USERNAME}
```

--------------------------------

### Create File Permissions Rule via HTTP

Source: https://docs.jetbackup.com/v5.3/api/FilePermissions/manageFilePermissions.html

This is an example HTTP GET request to create a file permissions rule. Replace `hostname.example.com` and `cpsess##########` with your actual server details.

```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
```
Tokens:
Raw