Clusterlogics API
- 1. List of backups available
- 2. Files for job by path
- 3. Files for job by node id (usefully for JavaScript three)
- 4. Restore files
- 5. Restore files by nodes id
- 6. Restore MySQL DB
- 7. Job status
- 8. Run
- 9. Cancel job
- 10. Get System
- 11. Browse client folders tree
- 12. Get information about downloading file: name, size and chucks
- 13. Download file with backup
- 14. Get name of client by its IP
- 15. Get pst file for MsExchange mailbox
- 16. Get MsExchange path for mailbox per client
- 17. Partial MsExchange Search for mailboxes
- 18. Get Baas zones
- 19. Get subusers Storages
- 20. Get subusers Servers
- 21. Get subusers Jobs
- 22. Get supported operating systems
- 23. Perform backup for client
- 24. Get config for client
- 25. Generate config for client
- 26. Get backup options for client
- 27. Get pool data for pool
- 28. Save pool
- 29. Add subuser
- 30. Grant access to subuser
- 31. Set subuser password
- 32. Check if subuser exist
- 33. Check subuser Bare Metal Restore access
- 34. Delete client
- 35. Get Job logs
- 36. Save fileset
POST
https://manage.clusterlogics.com/api/jobs/_IP_OF_SERVER
optional param path
NEW optional prams:
from and to - date in format Y-m-d H:i:s - limits job request by dates range for best performance.
e.g.:
returns jobs available for user "someuser"
POST
https://manage.clusterlogics.com/api/files/_JOB_ID_
Optional path (if empty - considering / )
Not recursive only content of folder specified
3. Files for job by node id (usefully for JavaScript three)
POST
https://manage.clusterlogics.com/api/nodes/_JOB_ID_/_NODE_ID
Node must be in child path of POST variable path.
If you brows incremental job it include all required files for FULL restore.
POST
https://manage.clusterlogics.com/api/restore/_JOB_ID_/_IP_OF_CLIENT_
Params:
files[0]=path of file
files[1]=path of file
.....
files[n]=path of file
List of files or folders you need to restore. In case if you define folder it would restore all files recurrently.
optional path - defines folder where files should be restored to if it / it would be restored to original location.
example:
returns job id (you need it to track status or process) or error if any arise.
POST
https://manage.clusterlogics.com/api/restorenodes/_JOB_ID/_CLIENT_IP
path = path where files should be restored should be / to restore original location
home = user home - system check if nodes are posted belongs this folder or sub folders
nodes[0]=_NODE_ID_
nodes[1]=_NODE_ID_
........
nodes[n]=_NODE_ID_
files[0]=_FILE_ID_
files[1]=_FILE_ID_
........
files[n]=_FILE_ID_
nodes -is folders
e.g.
POST
https://manage.clusterlogics.com/api/restoremysql/_JOB_ID/_DB_NAME
the target database must exists
client – optional restore client, name or ip. If empty to original server.
example:
GET
https://manage.clusterlogics.com/api/status/_JOB_ID
example:
should be used to know status of restore request
POST
https://manage.clusterlogics.com/api/run/_IP_OF_CLIENT
Execute command on file director
cmd = command to run
return result of output or error if any
example:
{ "result": "\/root\n" }
GET
https://manage.clusterlogics.com/api/cancel/_JOB_ID
e.g.:
POST
https://manage.clusterlogics.com/api/system/_SERVER_IP
{ "system": "unix" }
curl --request POST -H 'Accept: application/json' -u'your@loginemail.com:yourapikey' https://manage.clusterlogics.com/api/system/96.125.182.183
{ "system": "windows" }
note: server must have at list one backup job completed successfully.
11. Browse client folders tree
POST
https://manage.clusterlogics.com/api/restoretree/IP_OF_CLIENT
name = full path to folders
home = user home - system check if name are posted belongs this folder or sub folders
12. Get information about downloading file: name, size and chucks
POST
https://manage.clusterlogics.com/api/downloadinfo/JOB_ID/IP_OF_CLIENT
POST
https://manage.clusterlogics.com/api/download/JOB_ID/IP_OF_CLIENT/CHUCK
14. Get name of client by its IP
POST
https://manage.clusterlogics.com/api/getclientnamebyip/IP_OF_CLIENT
15. Get pst file for MsExchange mailbox
POST
https://manage.clusterlogics.com/api/msexchange/IP_OF_CLIENT/getemail
{ "mailbox": "mailbox@domain.com" }
16. Get MsExchange path for mailbox per client
POST
https://manage.clusterlogics.com/api/msexchange/IP_OF_CLIENT/path
{ "mailbox": "mailbox@domain.com" }
17. Partial MsExchange Search for mailboxes
POST
https://manage.clusterlogics.com/api/msexchange/IP_OF_CLIENT/search
{ "search": "a"}
18. Get Bacula as service zones
GET
https://manage.clusterlogics.com/api/getbaaszones
POST
https://manage.clusterlogics.com/api/storages
POST
https://manage.clusterlogics.com/api/servers
subuser = subusers login
{ "subuser": "someuser"}
POST
https://manage.clusterlogics.com/api/myjobs
subuser = subusers login
status = job status (optional)
limit = jobs portion limit (optional)
offset = jobs portion offset (optional)
{ "subuser": "someuser"}
22. Get supported operating systems
POST
https://manage.clusterlogics.com/api/supportedsystems
POST
https://manage.clusterlogics.com/api/backupnow/IP_OF_CLIENT/BACKUP_LEVEL
POST
https://manage.clusterlogics.com/api/getconfig/IP_OF_CLIENT/SYSTEM
POST
https://manage.clusterlogics.com/api/genconfig/SYSTEM
name = name of client
password = root password of client
IP = ip address of client
internalip = internal ip (optional)
26. Get backup options for client
POST
https://manage.clusterlogics.com/api/backupoptions/IP_OF_CLIENT/SYSTEM
POST
https://manage.clusterlogics.com/api/getpool/POOL_NAME
getstorage = storage (optional)
POST
https://manage.clusterlogics.com/api/savepool
POST
https://manage.clusterlogics.com/api/subuser/add
Login = subusers login
Firstname = subusers firstname
Lastname = subusers lastname
Email = subusers email address
POST
https://manage.clusterlogics.com/api/subuser/grant
client = name of client
subuser = subusers login
POST
https://manage.clusterlogics.com/api/subuser/password
subuser = subusers login
Password = subusers password to set
POST
https://manage.clusterlogics.com/api/subuser/check
subuser = subusers login
33. Check subuser Bare Metal Restore access
POST
https://manage.clusterlogics.com/api/subuser/bmr
subuser = subusers login
POST
https://manage.clusterlogics.com/api/deleteclient/CLIENT_NAME
subuser = subusers login
POST
https://manage.clusterlogics.com/api/joblog/JOB_ID
subuser = subusers login
POST
https://manage.clusterlogics.com/api/savefileset
$_POST = FileSet structure