Validate Path
This section includes the following topics:
Input Parameters
Output Parameters
Input Parameters
The following table provides the parameters and descriptions.
Parameter | Description |
diskLocation path | String disk path location. |
diskLocation credentials | Optional, in case the path is a network share that requires auth. userName - optional parameter to use for shares requiring auth. password - optional parameter to use for shares requiring auth. |
Example
Example for credential based auth on a remote host below. If a local folder is used, the credentials section is not required.
{
"diskLocation": {
"path": "\\\\server1\\share1\\folder1",
"credentials": {
"userName": "user1",
"password": "passwordtext"
}
}
}
Output Parameters
None when successful, validation errors otherwise:
CreateFolderFailed: general error. Most likely a local volume is read only or cannot be written to due to permissions on the local file system
Network shares only:
BackupSetActions_NetworkShareInaccessible - network share address could not be reached
BackupSetActions_NetworkPathNotFound - the network path could not be found
BackupSetActions_NetworkShareInvalidAuth - username + password combination failed authentication
BackupSetActions_NetworkShareNoWritePermissions - username and password ok, but no write permissions for the provided username on that share.
Example POST
POST /v2/accounts/test_acc/computers/0000/restore/diskimage/standard/vm/validate/path
Input Parameters
{
"diskLocation": {
"path": "\\\\server1\\share1\\folder1",
"credentials": {
"userName": "user1",
"password": "passwordtext"
}
}
}
Output Parameters
Response status: 204 No content (for online operation).