The api/db/<dbname>/backup/verify Resource

The api/db/<dbname>/backup/verify performs synchronous verification of a backup file. The only supported method is GET. Note that the operation is performed in a synchronous manner, and can take some time if the backup file is large.

The following query parameters are supported (which correspond to the arguments of the mco_backup_verify() C API function):

• file_name (required)
• label (default: none)
• cipher (default: none)

The response is a JSON object containing only one field, result, that contains the following fields:

• code: the return value of the mco_backup_verify() function
• str: the description of the error, as returned by mco_strerror(code)
• error; (optional) the error string returned by the mco_backup_verify() function, if available

For an overview see page eXtremeDB Web Service Resources

Examples

With the REST server started (listening on port 8083), the following http request will return the verification result for the given backup file:

 
    GET http://localhost:8083/api/db/diskdb/backup/verify?file_name=myfile.bkp            
     

The response, if this is a valid backup file, is a JSON object with only one key, result, that contains the following info:

   {
	"result":
	 {
		"code": 0,
		"str": "MCO_S_OK - Operation succeeded"
	}
  }

If the backup file path specified by file_name is invalid:

   {
	"result":
	 {
		"code": 101,
		"str": "MCO_E_DISK_OPEN - Unable to open persistent storage",	
		"error": "Failed to open backup file myfile.bkp"
	}
  }