Page tree
Skip to end of metadata
Go to start of metadata

Use the command line based FileCloud Automation app to integrate FileCloud with your existing business processes . The Automation app enables you to perform operations such as extracting files out of FileCloud and uploading files into FileCloud.

The FileCloud Automation app (cloudapi) is currently only available on Windows platforms. If you need access to the app for other operating systems, please contact customer support.

Installation of the the app is straight forward, just download the zip file and unzip it to any folder and run the cloudapi executable.

Supported arguments

The following arguments are currently processed by the app.

ArgumentExplanation
-?Show Help
--userusername to use to do the action
--passwordpassword for the associated user
--hostfull URL to the server, e.g. http://files.xyz.com
--operationtype of operation to perform (more details below)
--remotepathusually remote path in the server
--remotenameusually remote name in the server
--localpathusually local path in the local machine
--sslverify

whether to enable/disable ssl verification

Values:
VERIFY_STRICT - (default) enable strict SSL verification
VERIFY_NONE
- disable SSL verification

Supported operations and examples

OperationDetailed Description
UPLOADUploads a specific local file to the remote server 

cloudapi --user USERNAME --password PASSWORD --host SERVERURL --operation UPLOAD --remotepath PARENTPATH --localpath FILEPATH --sslverify VERIFY_STRICT

Example:
cloudapi --user john --password mypassword --host http://files.xyz.com --operation UPLOAD --remotepath /john/myfolder --localpath c:/users/john/desktop/doc1.docx -sslverify VERIFY_STRICT

DOWNLOAD

Downloads a specific file from the remote server to the local location

cloudapi --user USERNAME --password PASSWORD --host SERVERURL --operation DOWNLOAD --remotepath FULLPATH --remotename NAME --localpath FILEPATH --sslverify VERIFY_STRICT

Example:
cloudapi --user john --password mypassword --host http://files.xyz.com --operation DOWNLOAD --remotepath /john/myfolder/doc1.docx --remotename doc1.docx --localpath c:/users/john/desktop/doc2.docx -sslverify VERIFY_STRICT

CREATEFOLDER

Create a remote folder on the server

cloudapi --user USERNAME --password PASSWORD --host SERVERURL --operation CREATEFOLDER --remotepath PARENTPATH --remotename NAME --sslverify VERIFY_STRICT

Example:
cloudapi --user john --password mypassword --host http://files.xyz.com --operation CREATEFOLDER --remotepath /john/myfolder --remotename newfolder -sslverify VERIFY_STRICT

DELETE

Delete a file or folder on the server

cloudapi --user USERNAME --password PASSWORD --host SERVERURL --operation DELETE --remotepath PARENTPATH --remotename NAME --sslverify VERIFY_STRICT

Example:

cloudapi --user john --password mypassword --host http://files.xyz.com --operation DELETE --remotepath /john/myfolder --remotename doc1.docx -sslverify VERIFY_STRICT

UPLOADFOLDER

Uploads a folder recursively from the local machine to the remote server on the specified path

cloudapi --user USERNAME --password PASSWORD --host SERVERURL --operation UPLOADFOLDER --remotepath PARENTPATH --localpath LOCALFOLDERPATH --sslverify VERIFY_STRICT

Example:

cloudapi --user john --password mypassword --host http://files.xyz.com --operation UPLOADFOLDER --remotepath /john/myfolder --localpath c:/users/john/desktop/localdata -sslverify VERIFY_STRICT

DOWNLOADFOLDER

Downloads a folder recursively from the remote server to the local machine. Download will skip files if they are already present and if they have the same size as the size on the server.

cloudapi --user USERNAME --password PASSWORD --host SERVERURL --operation DOWNLOADFOLDER --remotepath FULLPATH --localpath LOCALFOLDERPATH --sslverify VERIFY_STRICT

Example:

cloudapi --user john --password mypassword --host http://files.xyz.com --operation DOWNLOADFOLDER --remotepath /john/myfolder --localpath c:/users/john/desktop/localdatabakup -sslverify VERIFY_STRICT


All example commands in the table specify paths for locally managed storage (My Files). 

To create a folder in a public share specify the path as::

cloudapi.exe --user john --password mypassword --host https://test.filecloudlabs.com --operation CREATEFOLDER --remotepath "/SHARED/!YvTLNFLKvF2ME6WWy/eNSaRm0tpHrwe2LQ" --remotename newfolder -sslverify VERIFY_STRICT

The remote path "/SHARED/!YvTLNFLKvF2ME6WWy/eNSaRm0tpHrwe2LQ" is obtained from the share url.

  • No labels