/backup

• GET /api/v1/backup

• POST /api/v1/backup?cmd=

GET /api/v1/backup

Retrieve the backup status.

Example request:

curl -X GET "http://localhost:4000/api/v1/backup" -H "accept: application/json"

GET /api/v1/backup HTTP/1.1
Host: localhost:4000
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "inProgress": false,
  "isMineInProgress": false,
  "isMineCompleted": false,
  "numFileSuccessful": 0,
  "numUserObjsSuccessful": 0,
  "numNameObjsSuccessful": 0,
  "numDependObjsSuccessful": 0,
  "numUserObjsSkipped": 0,
  "numNameObjsSkipped": 0,
  "numDependObjsSkipped": 0,
  "status": "OK",
  "statusCode": 0,
  "numFilesFailed": 0,
  "numObjsSuccessful": 0,
  "numObjsFailed": 0,
  "numObjsSkipped": 0,
  "dirPath": "",
  "fileID": "",
  "isBackup": false,
  "hostID": "0.0.0.0",
  "appID": 0,
  "useMaxFileLen": false,
  "maxFileLen": 0,
  "overwrite": false,
  "history": []
}

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – The list of backup was retrieved successfully.

• 503 Service Unavailable – Cannot access the StateServer service or the store was not ready. See the JSON response for more information.

• 400 Bad Request – The default store was deselected, or the ScaleOut StateServer is not licensed for this feature. See the JSON response for more information.

• 500 Internal Server Error – Internal error, see the JSON response for more information.

Response JSON Object

• inProgress (boolean) – true if the backup is in progress

• isMineInProgress (boolean) –

• isMineCompleted (boolean) –

• numFileSuccessful (integer) –

• numUserObjsSuccessful (integer) –

• numNameObjsSuccessful (integer) –

• numDependObjsSuccessful (integer) –

• numUserObjsSkipped (integer) –

• numNameObjsSkipped (integer) –

• numDependObjsSkipped (integer) –

• status (string) –

• statusCode (integer) –

• numFilesFailed (integer) –

• numObjsSuccessful (integer) –

• numObjsFailed (integer) –

• numObjsSkipped (integer) –

• dirPath (string) –

• fileID (string) –

• isBackup (boolean) –

• hostID (string) – The IP address of the host

• appID (integer) –

• useMaxFileLen (boolean) –

• maxFileLen (integer) –

• overwrite (boolean) –

• history (array) – the list of past backup jobs

POST /api/v1/backup

Retrieve the backup status.

Example request:

curl -X POST "http://localhost:4000/api/v1/backup?cmd=backup" -H "accept: application/json"

POST /api/v1/backup?cmd=backup HTTP/1.1
Host: localhost:4000
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 OK
Vary: Accept
Content-Type: application/json

Response Headers

• Content-Type – application/json

Query Parameters

• cmd – The command to run. One of backup, restore or cancel.

• appName – Required for backup, restore commands, ignored otherwise.

• dirPath – Required for backup, restore commands, ignored otherwise.

• id – Required for backup, restore commands, ignored otherwise.

• filesize – Required for backup commands, ignored otherwise.

• overwrite – Required for restore commands, ignored otherwise.

Status Codes

• 204 No Content – The command executed successfully.

• 400 Bad Request – Unknown command. See the JSON response for more information.

• 500 Internal Server Error – Internal error, see the JSON response for more information.

Response JSON Object

• code (string) – Error code

• subcode (string) – Error subcode

• message (string) – Description of the error