NOTICE: This Documentation is for JetBackup 4 for Linux.

Please CLICK HERE for the latest JetBackup 5 for Linux Documentation.

JetBackup for Linux API Documentation

Introduction

JetBackup for Linux 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 for Linux API, you can manage and optimize backup jobs within all your servers.

Authentication

In order to communicate with the JetBackup server, you will need to create an API Access Token through Users section of JetBackup or through Manage Access Token API Call.
After creating the API access token, you will need to pass it in the request header, for example:
curl -k -H "Authorization: Bearer testuser:9MKjw55we7TIq0CdpaHaiYHacB5hQOqp" "https://1.1.1.1:3030/API/manageServer/?_id=5b30da08d5ac5e06897b47e2&action=modify&name=JBServer1"

Basic usage

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

 $query = "https://HOST_NAME:3030/API/";

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

 $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: Bearer $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=384"

#! /bin/bash
user=USER
token=USERAPITOKEN
header='Authorization: Bearer '$user':'$token

query='https://HOST_NAME:3030/API/'

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

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":"Logged In Successfully",
   "system":
   {
      "version":"1.0.2",
       "tier":"Stable",
       "type":"Linux",
       "drMode":,
       "agreement":,
      "licenseIssue":false
   },
   "data":{}
}

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.