1. Remote to Cloud (File Upload) - Transfer files from a remote machine to Qntrl's File module, effectively uploading them to your cloud-based storage.
2. Cloud to Remote (File Download) - Transfer files from Qntrl's File module to a remote machine. This is particularly useful when you need to retrieve files stored in the cloud and download them to your local device.
3. Remote to Remote (File Transfer) - Transfers files between two machines connected to the same network. It's ideal for moving files directly between remote devices within your network.

Supported file operations

Recursive is not supported for File Download tasks, for downloading a file from Cloud storage.

Use Case

Prerequisite

• While creating Credentials, select Type as SSH and provide the user name and password for your remote machine. Click here to learn how to create a credential.

• An authenticated connection has to be established to interact with the File module. Refer to the OAuth configuration section within the Bridge Agent to make a connection with the File module.

Payload Formats

1. Cloud to Remote (File Download)

{
	"task_name": "file_task",
	"task_details": {
		"source": {
			"cloud": {
				"path": "<QNTRL FILE MODULE PATH>",
				"type": "qntrl_files"
			 }
 		},
		"destination": {
			"remote": {
				"path": "<REMOTE FILE PATH>",
				"credential_name": "<CREDENTIAL_NAME>",
				"host": "localhost"
			}
		}
	}
}

2. Remote to Cloud (File Upload)

{
	"task_name": "file_task",
	"action": "<move/copy>",
	"subfolder_copy": <true/false>,
	"task_details": {
		"source": {
			"remote": {
				"path": "<REMOTE FILE MODULE PATH>",
				"credential_name": "<CREDENTIAL_NAME>",
				"host": "localhost"
			}
		},	
		"destination": {
			"cloud": {
				"path": "<QNTRL FILE MODULE PATH>",
				"type": "qntrl_files",
				"overwrite": true
			}
		}
	}
}

{
	"task_name": "file_task",
	"action": "<move/copy>",
	"subfolder_copy": <true/false>,
	"task_details": {
		"source": {
			"remote": {
				"path": "<FILE PATH>",
 				"credential_name": "<REMOTE CREDENTIAL NAME>",
				 "host": "<HOST NAME>"
			 }
		 },
		"destination": {
			"remote": {
				"path": "<FILE PATH>",
				"credential_name": "<REMOTE CREDENTIAL NAME>",
				"host": "<Host Name>"
			}
		}
	} 
}

The regex pattern (*) is not supported for 'Move' operations.