WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

WHM API Documentation

Introduction

JetBackup API accesses the JetBackup interface's features.
You can use this API to perform all the tasks you perform from the JetBackup GUI and more,
With JetBackup API you can create destinations, jobs, and manage settings etc.

API Token

API tokens allow you to log in to the server without the need for a password.
You can use an API token to authenticate with JetBackup's remote API.
For more details about API tokens click on: How To Retrieve API Tokens?

Basic usage

<?php
    $user = "root";
    $token = "MYAPITOKEN";

    $query = "https://HOST_NAME:2087/cgi/addons/jetbackup/api.cgi";

    $params = [
        'function' => 'listBackups',
        'type' => 127,
    ];

    $curl = curl_init();
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

    $header = ["Authorization: whm $user:$token"];

    curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
    curl_setopt($curl, CURLOPT_URL, $query);
    curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($params));

    $result = curl_exec($curl);

    $http_status = curl_getinfo($curl, CURLINFO_HTTP_CODE);

    if ($http_status != 200) {
        echo "[!] Error: " . $http_status . " returned\n";
    } else {
        $json = json_decode($result);
        print_r($json);
    }

    curl_close($curl);
?>

jetapi backup -F listBackups -D "type=127"

#! /bin/bash
user=root
token=MYAPITOKEN
header='Authorization: whm '$user':'$token

query='https://HOST_NAME:2087/cgi/addons/jetbackup/api.cgi'

params='{"function":"listBackups","type":127}'

curl $query -H "$header" -d $params -k
The term "Boolean" in our documentation refers to parameters that accept values of 1 or 0.
We don't support the literal values of true and false.

For more information about jetapi basic usage click on Jetapi Parameters

API Response

On each function page, you will find details for the response data.
All the API call returns this object:
{
   "success":1,
   "message":"",
   "data":{},
   "system":
   {
      "version":"4.0",
      "tier":"STABLE",
      "drMode":false,
      "agreement":false,
      "licenseIssue":false
   }
}

Parameters

Parameter name Type Description Possible values Example
success Boolean Whether the API call was successful.    
message String Success/failure message.   You already have a download for this backup.
data Object The returned data.    
system Object System information. To view the possible values click on System Object