BackupManager API description

API request URL: /CMD_PLUGINS/backup_manager/api.raw?CMD_API=<FUNCTION_NAME>

Available functions:

• BM_BACKUP_LOCATIONS
• BM_FILES_LIST_BACKUPS
• BM_MYSQL_LIST_BACKUPS
• BM_FILES_LIST_FILES
• BM_MYSQL_LIST_FILES
• BM_FILES_RECOVER
• BM_FILES_SAVE
• BM_MYSQL_RECOVER
• BM_MYSQL_SAVE
• BM_TASK_SATUS

Before you begin you need to get httpsocket.php from DirectAdmin:

wget http://files.directadmin.com/services/all/httpsocket/httpsocket.php.3.0.2 -O httpsocket.php

BM_BACKUP_LOCATIONS

List enabled backup locations. BackupManager currentlysupports: Local,Remote(rsync), FTP and S3 object storages. Usage:

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_BACKUP_LOCATIONS');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_FILES_LIST_BACKUPS

List files backup in the storage.

SID = Backup location (local/remote/ftp/s3)

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_FILES_LIST_BACKUPS&SID=local');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_MYSQL_LIST_BACKUPS

List MySQL backup in the storage.

SID = Backup location (local/remote/ftp/s3)

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_MYSQL_LIST_BACKUPS&SID=local');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_FILES_LIST_FILES

List files and foldes on the files backup

SID = Backup location (local/remote/ftp/s3)

BID = Backup ID from BM_FILES_LIST_BACKUPS query result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_FILES_LIST_FILES&SID=local&BID=0');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_MYSQL_LIST_FILES

List databases on the MySQL backup

SID = Backup location (local/remote/ftp/s3)

BID = Backup ID from BM_MYSQL_LIST_BACKUPS query result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_MYSQL_LIST_FILES&SID=local&BID=0');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_FILES_RECOVER

Request file or folder recovery from files backup

SID = Backup location (local/remote/ftp/s3)

BID = Backup ID from BM_MYSQL_LIST_BACKUPS query result

FID = Files name from BM_FILES_LIST_FILES query result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_FILES_RECOVER&SID=local&BID=0&FID=test.txt');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_FILES_SAVE

Request file or folder save to home folder from files backup

SID = Backup location (local/remote/ftp/s3)

BID = Backup ID from BM_MYSQL_LIST_BACKUPS query result

FID = Files name from BM_FILES_LIST_FILES query result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_FILES_SAVE&SID=local&BID=0&FID=test.txt');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_MYSQL_RECOVER

Request database recovery from MySQL backup

SID = Backup location (local/remote/ftp/s3)

BID = Backup ID from BM_MYSQL_LIST_BACKUPS query result

FID = Files name from BM_MYSQL_LIST_FILES query result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_FILES_RECOVER&SID=local&BID=0&FID=demouser_db1-00-45-01-02-03-2019.gz');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_MYSQL_SAVE

Request database save to home folder from MySQL backup

SID = Backup location (local/remote/ftp/s3)

BID = Backup ID from BM_MYSQL_LIST_BACKUPS query result

FID = Files name from BM_MYSQL_LIST_FILES query result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_FILES_SAVE&SID=local&BID=0&FID=demouser_db1-00-45-01-02-03-2019.gz');
$result = $sock->fetch_parsed_body();
print_r($result);

BM_TASK_SATUS

Request recovery or save task status.

TID = Task ID from recovery/save request result

include 'httpsocket.php';
$sock = new HTTPSocket;
$sock->connect('myserver.com',2222);
$sock->set_login('admin','MySecuredPassword');
$sock->query('/CMD_PLUGINS/backup_manager/api.raw?CMD_API=BM_TASK_SATUS&TID=a94c5d9096600dabd86653bc496f449b');
$result = $sock->fetch_parsed_body();
print_r($result);