Backup/Restore API
https://boxrestore.clirisgroup.com
This document presents the way to use the API "boxrestore". This REST API is developed in order to backup and restore box.
/box
get
get information of backuped box
get /box/info
get information of backuped box
Headers
- Authorization: required(string)
Example:
Bearer your_token
Body
Media type: application/json
Type: object
Properties- ip: required(string)
HTTP status code 201
OK
Body
Media type: application/json
Type: any
Example:
[
{
"dir_name": "9990001_10.8.14.30_DD999-CYRIA08",
"hostname": "DD999-CYRIA08",
"id_site": "9990001",
"lsc_version": "5.1.18012 ",
"lsc_dir": "cliris",
"tbs_version": "4.2.svn17927",
"etl_version": "2.12",
"etl2_version": "NO",
"etl3d_version": "NO",
"datasync_version": "1.08",
"autitapt_version": "1.6",
"status": "ok"
}
]
HTTP status code 404
Unauthorized
Body
Media type: application/json
Type: any
Example:
{
"success": False,
"error":"Unauthorized access :Invalid Token Error"
}
post
launch backup of a box with ip
post /box/backup
launch backup of a box with ip
Headers
- Authorization: required(string)
Example:
Bearer your_token
Body
Media type: application/json
Type: object
Properties- ip: required(string)
post
launch restore a box from backup
post /box/restore
launch restore a box from backup
Headers
- Authorization: required(string)
Example:
Bearer your_token
Body
Media type: application/json
Type: object
Properties- destinationBox: required(string)
- Backup_directory: required(string)
- lscversionSource: required(string)
- lscversiondestination: required(string)
- etlordatasync: required(string)
- api_url: required(string)
- id_site: required(integer)
- codeClient: required(string)
- lincenses: required(string)
Examples:
exemple1:
Restore to a box with datasync
{
"destinationBox": "192.168.1.184",
"Backup_directory": "9990001_10.8.14.30_DD999-CYRIA08",
"lscversionSource": "cliris",
"lscversiondestination": "5X",
"etlordatasync": "datasync",
"api_url": "https://getmeasure.cc999.clirisgroup.com",
"id_site": 9990001,
"codeClient": "cc999",
"lincenses": "AAAAAA-BBBBBB,CCCCCCC-DDDDDDD,EEEEEEE-FFFFFF"
}
exemple2:
Restore to a box with etl2
{
"destinationBox": "192.168.1.184",
"Backup_directory": "9990001_10.8.14.30_DD999-CYRIA08",
"lscversionSource": "cliris",
"lscversiondestination": "5X",
"etlordatasync": "etl",
"api_url": "",
"id_site": 0,
"codeClient": "",
"lincenses": "AAAAAA-BBBBBB,CCCCCCC-DDDDDDD,EEEEEEE-FFFFFF"
}