Remote Servers

A RemoteServer is a specific type of Behavior called remote_server_sync.

Remote Servers can be either an FTP server, SFTP server, S3 bucket, Google Cloud Storage, Wasabi, Backblaze B2 Cloud Storage, Rackspace Cloud Files container, WebDAV, Box, Dropbox, OneDrive, SharePoint, Google Drive, Azure Blob Storage, or Files.com direct link.

Not every attribute will apply to every remote server.

FTP Servers require that you specify their hostname, port, username, password, and a value for ssl. Optionally, provide server_certificate.

SFTP Servers require that you specify their hostname, port, username, password or private_key, and a value for ssl. Optionally, provide server_certificate, private_key_passphrase.

S3 Buckets require that you specify their s3_bucket name, and s3_region. Optionally provide a aws_access_key, and aws_secret_key. If you don't provide credentials, you will need to use AWS to grant us access to your bucket.

S3-Compatible Buckets require that you specify s3_compatible_bucket, s3_compatible_endpoint, s3_compatible_access_key, and s3_compatible_secret_key. Optionally provide s3_compatible_virtual_hosted_style to use virtual-hosted-style URLs instead of path-style URLs.

Google Cloud Storage requires that you specify google_cloud_storage_bucket, and then one of the following sets of authentication credentials, selected by google_cloud_storage_authentication_method (defaults to json):

  • for JSON authentication: google_cloud_storage_project_id, and google_cloud_storage_credentials_json
  • for HMAC (S3-Compatible) authentication: google_cloud_storage_s3_compatible_access_key, and google_cloud_storage_s3_compatible_secret_key
  • for OAuth authentication: google_cloud_storage_oauth_scope, then follow the auth_setup_link and login with Google

Wasabi requires wasabi_bucket, wasabi_region, wasabi_access_key, and wasabi_secret_key.

Backblaze B2 Cloud Storage backblaze_b2_bucket, backblaze_b2_s3_endpoint, backblaze_b2_application_key, and backblaze_b2_key_id. (Requires S3 Compatible API) See https://help.backblaze.com/hc/en-us/articles/360047425453

WebDAV Servers require that you specify their hostname, username, and password.

OneDrive follow the auth_setup_link and login with Microsoft.

SharePoint supports delegated authentication through auth_setup_link, or app-only authentication with sharepoint_tenant_id, sharepoint_client_id, and either sharepoint_client_secret or sharepoint_client_certificate. Set sharepoint_site_url to scope the remote server to a site granted through Microsoft Graph Sites.Selected; leave it blank to browse all sites.

Box follow the auth_setup_link and login with Box.

Dropbox specify if dropbox_teams then follow the auth_setup_link and login with Dropbox.

Google Drive follow the auth_setup_link and login with Google.

Azure Blob Storage azure_blob_storage_account, azure_blob_storage_container, azure_blob_storage_access_key, azure_blob_storage_sas_token, azure_blob_storage_dns_suffix

Azure File Storage azure_files_storage_account, azure_files_storage_access_key, azure_files_storage_share_name, azure_files_storage_dns_suffix

Filebase requires filebase_bucket, filebase_access_key, and filebase_secret_key.

Cloudflare requires cloudflare_bucket, cloudflare_access_key, cloudflare_secret_key and cloudflare_endpoint.

Linode requires linode_bucket, linode_access_key, linode_secret_key and linode_region.

List Remote Servers

Command

files-cli remote-servers list

Output

Outputs a list of RemoteServer objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--user-id=
int64
User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

files-cli remote-servers list \
  --user-id=1

Show Remote Server

Command

files-cli remote-servers find

Output

Outputs a RemoteServer object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
Remote Server ID.

Example Request

files-cli remote-servers find \
  --id=1

Create Remote Server

Command

files-cli remote-servers create

Output

Outputs a RemoteServer object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDefaultDescription
--user-id=
int64
User ID. Provide a value of 0 to operate the current session's user.
--password=
string
Password, if needed.
--private-key=
string
Private key, if needed.
--private-key-passphrase=
string
Passphrase for private key if needed.
--reset-authentication
boolean
Reset authenticated account?
--sharepoint-client-certificate=
string
SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
--sharepoint-client-secret=
string
SharePoint: Microsoft Entra application client secret for app-only authentication.
--ssl-certificate=
string
SSL client certificate.
--aws-secret-key=
string
AWS: secret key.
--azure-blob-storage-access-key=
string
Azure Blob Storage: Access Key
--azure-blob-storage-sas-token=
string
Azure Blob Storage: Shared Access Signature (SAS) token
--azure-files-storage-access-key=
string
Azure File Storage: Access Key
--azure-files-storage-sas-token=
string
Azure File Storage: Shared Access Signature (SAS) token
--backblaze-b2-application-key=
string
Backblaze B2 Cloud Storage: applicationKey
--backblaze-b2-key-id=
string
Backblaze B2 Cloud Storage: keyID
--cloudflare-secret-key=
string
Cloudflare: Secret Key
--filebase-secret-key=
string
Filebase: Secret Key
--google-cloud-storage-credentials-json=
string
Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
--google-cloud-storage-s3-compatible-secret-key=
string
Google Cloud Storage: S3-compatible secret key
--linode-secret-key=
string
Linode: Secret Key
--s3-compatible-secret-key=
string
S3-compatible: Secret Key
--wasabi-secret-key=
string
Wasabi: Secret Key
--allow-relative-paths
boolean
falseAllow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
--aws-access-key=
string
AWS Access Key.
--azure-blob-storage-account=
string
Azure Blob Storage: Account name
--azure-blob-storage-container=
string
Azure Blob Storage: Container name
--azure-blob-storage-dns-suffix=
string
Azure Blob Storage: Custom DNS suffix
--azure-blob-storage-hierarchical-namespace
boolean
Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
--azure-files-storage-account=
string
Azure Files: Storage Account name
--azure-files-storage-dns-suffix=
string
Azure Files: Custom DNS suffix
--azure-files-storage-share-name=
string
Azure Files: Storage Share name
--backblaze-b2-bucket=
string
Backblaze B2 Cloud Storage: Bucket name
--backblaze-b2-s3-endpoint=
string
Backblaze B2 Cloud Storage: S3 Endpoint
--buffer-uploads=
string
"auto"If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
Possible values: auto, always, never
--cloudflare-access-key=
string
Cloudflare: Access Key.
--cloudflare-bucket=
string
Cloudflare: Bucket name
--cloudflare-endpoint=
string
Cloudflare: endpoint
--description=
string
Internal description for your reference
--dropbox-teams
boolean
falseDropbox: If true, list Team folders in root?
--enable-dedicated-ips
boolean
truetrue if remote server only accepts connections from dedicated IPs
--filebase-access-key=
string
Filebase: Access Key.
--filebase-bucket=
string
Filebase: Bucket name
--files-api-key=
string
Files.com direct link: API key used once to pair the remote server.
--files-agent-permission-set=
string
Local permissions for files agent. read_only, write_only, or read_write
Possible values: read_write, read_only, write_only
--files-agent-root=
string
Agent local root path
--files-agent-version=
string
Files Agent version
--outbound-agent-id=
int64
Route traffic to outbound on a files-agent
--google-cloud-storage-authentication-method=
string
"json"Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
Possible values: json, hmac, oauth
--google-cloud-storage-bucket=
string
Google Cloud Storage: Bucket Name
--google-cloud-storage-oauth-scope=
string
Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
--google-cloud-storage-project-id=
string
Google Cloud Storage: Project ID
--google-cloud-storage-s3-compatible-access-key=
string
Google Cloud Storage: S3-compatible Access Key.
--hostname=
string
Hostname or IP address
--linode-access-key=
string
Linode: Access Key
--linode-bucket=
string
Linode: Bucket name
--linode-region=
string
Linode: region
--max-connections=
int64
10Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
--name=
string
Internal name for your reference
--one-drive-account-type=
string
OneDrive: Either personal or business_other account types
Possible values: personal, business_other
--pin-to-site-region
boolean
falseIf true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
--port=
int64
Port for remote server.
--upload-staging-path=
string
Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
--remote-server-credential-id=
int64
ID of Remote Server Credential, if applicable.
--s3-assume-role-arn=
string
AWS IAM Role ARN for AssumeRole authentication.
--s3-assume-role-duration-seconds=
int64
Session duration in seconds for AssumeRole authentication (900-43200).
--s3-bucket=
string
S3 bucket name
--s3-compatible-access-key=
string
S3-compatible: Access Key
--s3-compatible-bucket=
string
S3-compatible: Bucket name
--s3-compatible-endpoint=
string
S3-compatible: endpoint
--s3-compatible-region=
string
S3-compatible: region
--s3-compatible-virtual-hosted-style
boolean
falseS3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
--s3-region=
string
S3 region
--server-certificate=
string
"require_match"Remote server certificate
Possible values: require_match, allow_any
--server-host-key=
string
Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
--server-type=
string
Remote server type.
Possible values: ftp, sftp, s3, google_cloud_storage, webdav, wasabi, backblaze_b2, one_drive, box, dropbox, google_drive, azure, sharepoint, s3_compatible, azure_files, files_agent, filebase, cloudflare, linode, files_com
--sharepoint-client-id=
string
SharePoint: Microsoft Entra application client ID for app-only authentication.
--sharepoint-site-url=
string
SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
--sharepoint-tenant-id=
string
SharePoint: Microsoft Entra tenant ID for app-only authentication.
--ssl=
string
"if_available"Should we require SSL?
Possible values: if_available, require, require_implicit, never
--username=
string
Remote server username.
--wasabi-access-key=
string
Wasabi: Access Key.
--wasabi-bucket=
string
Wasabi: Bucket name
--wasabi-region=
string
Wasabi: Region
--workspace-id=
int64
0Workspace ID (0 for default workspace)

Example Request

files-cli remote-servers create \
  --user-id=1

Update Remote Server

Command

files-cli remote-servers update

Output

Outputs a RemoteServer object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
Remote Server ID.
--password=
string
Password, if needed.
--private-key=
string
Private key, if needed.
--private-key-passphrase=
string
Passphrase for private key if needed.
--reset-authentication
boolean
Reset authenticated account?
--sharepoint-client-certificate=
string
SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
--sharepoint-client-secret=
string
SharePoint: Microsoft Entra application client secret for app-only authentication.
--ssl-certificate=
string
SSL client certificate.
--aws-secret-key=
string
AWS: secret key.
--azure-blob-storage-access-key=
string
Azure Blob Storage: Access Key
--azure-blob-storage-sas-token=
string
Azure Blob Storage: Shared Access Signature (SAS) token
--azure-files-storage-access-key=
string
Azure File Storage: Access Key
--azure-files-storage-sas-token=
string
Azure File Storage: Shared Access Signature (SAS) token
--backblaze-b2-application-key=
string
Backblaze B2 Cloud Storage: applicationKey
--backblaze-b2-key-id=
string
Backblaze B2 Cloud Storage: keyID
--cloudflare-secret-key=
string
Cloudflare: Secret Key
--filebase-secret-key=
string
Filebase: Secret Key
--google-cloud-storage-credentials-json=
string
Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
--google-cloud-storage-s3-compatible-secret-key=
string
Google Cloud Storage: S3-compatible secret key
--linode-secret-key=
string
Linode: Secret Key
--s3-compatible-secret-key=
string
S3-compatible: Secret Key
--wasabi-secret-key=
string
Wasabi: Secret Key
--allow-relative-paths
boolean
Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
--aws-access-key=
string
AWS Access Key.
--azure-blob-storage-account=
string
Azure Blob Storage: Account name
--azure-blob-storage-container=
string
Azure Blob Storage: Container name
--azure-blob-storage-dns-suffix=
string
Azure Blob Storage: Custom DNS suffix
--azure-blob-storage-hierarchical-namespace
boolean
Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
--azure-files-storage-account=
string
Azure Files: Storage Account name
--azure-files-storage-dns-suffix=
string
Azure Files: Custom DNS suffix
--azure-files-storage-share-name=
string
Azure Files: Storage Share name
--backblaze-b2-bucket=
string
Backblaze B2 Cloud Storage: Bucket name
--backblaze-b2-s3-endpoint=
string
Backblaze B2 Cloud Storage: S3 Endpoint
--buffer-uploads=
string
If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
Possible values: auto, always, never
--cloudflare-access-key=
string
Cloudflare: Access Key.
--cloudflare-bucket=
string
Cloudflare: Bucket name
--cloudflare-endpoint=
string
Cloudflare: endpoint
--description=
string
Internal description for your reference
--dropbox-teams
boolean
Dropbox: If true, list Team folders in root?
--enable-dedicated-ips
boolean
true if remote server only accepts connections from dedicated IPs
--filebase-access-key=
string
Filebase: Access Key.
--filebase-bucket=
string
Filebase: Bucket name
--files-api-key=
string
Files.com direct link: API key used once to pair the remote server.
--files-agent-permission-set=
string
Local permissions for files agent. read_only, write_only, or read_write
Possible values: read_write, read_only, write_only
--files-agent-root=
string
Agent local root path
--files-agent-version=
string
Files Agent version
--outbound-agent-id=
int64
Route traffic to outbound on a files-agent
--google-cloud-storage-authentication-method=
string
Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
Possible values: json, hmac, oauth
--google-cloud-storage-bucket=
string
Google Cloud Storage: Bucket Name
--google-cloud-storage-oauth-scope=
string
Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
--google-cloud-storage-project-id=
string
Google Cloud Storage: Project ID
--google-cloud-storage-s3-compatible-access-key=
string
Google Cloud Storage: S3-compatible Access Key.
--hostname=
string
Hostname or IP address
--linode-access-key=
string
Linode: Access Key
--linode-bucket=
string
Linode: Bucket name
--linode-region=
string
Linode: region
--max-connections=
int64
Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
--name=
string
Internal name for your reference
--one-drive-account-type=
string
OneDrive: Either personal or business_other account types
Possible values: personal, business_other
--pin-to-site-region
boolean
If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
--port=
int64
Port for remote server.
--upload-staging-path=
string
Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
--remote-server-credential-id=
int64
ID of Remote Server Credential, if applicable.
--s3-assume-role-arn=
string
AWS IAM Role ARN for AssumeRole authentication.
--s3-assume-role-duration-seconds=
int64
Session duration in seconds for AssumeRole authentication (900-43200).
--s3-bucket=
string
S3 bucket name
--s3-compatible-access-key=
string
S3-compatible: Access Key
--s3-compatible-bucket=
string
S3-compatible: Bucket name
--s3-compatible-endpoint=
string
S3-compatible: endpoint
--s3-compatible-region=
string
S3-compatible: region
--s3-compatible-virtual-hosted-style
boolean
S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
--s3-region=
string
S3 region
--server-certificate=
string
Remote server certificate
Possible values: require_match, allow_any
--server-host-key=
string
Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
--server-type=
string
Remote server type.
Possible values: ftp, sftp, s3, google_cloud_storage, webdav, wasabi, backblaze_b2, one_drive, box, dropbox, google_drive, azure, sharepoint, s3_compatible, azure_files, files_agent, filebase, cloudflare, linode, files_com
--sharepoint-client-id=
string
SharePoint: Microsoft Entra application client ID for app-only authentication.
--sharepoint-site-url=
string
SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
--sharepoint-tenant-id=
string
SharePoint: Microsoft Entra tenant ID for app-only authentication.
--ssl=
string
Should we require SSL?
Possible values: if_available, require, require_implicit, never
--username=
string
Remote server username.
--wasabi-access-key=
string
Wasabi: Access Key.
--wasabi-bucket=
string
Wasabi: Bucket name
--wasabi-region=
string
Wasabi: Region

Example Request

files-cli remote-servers update \
  --id=1

Delete Remote Server

Command

files-cli remote-servers delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
Remote Server ID.

Example Request

files-cli remote-servers delete \
  --id=1

The RemoteServer Object

Some of the commands above return a RemoteServer object. The attributes of this object are listed below.

AttributeDescription
id
int64
Remote Server ID
disabled
boolean
If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
authentication_method
string
Type of authentication method to use
hostname
string
Hostname or IP address
remote_home_path
string
Initial home folder on remote server
upload_staging_path
string
Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
allow_relative_paths
boolean
Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
name
string
Internal name for your reference
description
string
Internal description for your reference
port
int64
Port for remote server.
buffer_uploads
string
If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
Possible values: auto, always, never
max_connections
int64
Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
pin_to_site_region
boolean
If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
pinned_region
string
If set, all communications with this remote server are made through the provided region.
remote_server_credential_id
int64
ID of Remote Server Credential, if applicable.
s3_bucket
string
S3 bucket name
s3_region
string
S3 region
aws_access_key
string
AWS Access Key.
s3_assume_role_arn
string
AWS IAM Role ARN for AssumeRole authentication.
s3_assume_role_duration_seconds
int64
Session duration in seconds for AssumeRole authentication (900-43200).
s3_assume_role_external_id
string
External ID for AssumeRole authentication.
server_certificate
string
Remote server certificate
Possible values: require_match, allow_any
server_host_key
string
Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type
string
Remote server type.
Possible values: ftp, sftp, s3, google_cloud_storage, webdav, wasabi, backblaze_b2, one_drive, box, dropbox, google_drive, azure, sharepoint, s3_compatible, azure_files, files_agent, filebase, cloudflare, linode, files_com
workspace_id
int64
Workspace ID (0 for default workspace)
ssl
string
Should we require SSL?
Possible values: if_available, require, require_implicit, never
username
string
Remote server username.
google_cloud_storage_bucket
string
Google Cloud Storage: Bucket Name
google_cloud_storage_authentication_method
string
Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
Possible values: json, hmac, oauth
google_cloud_storage_oauth_scope
string
Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
google_cloud_storage_project_id
string
Google Cloud Storage: Project ID
google_cloud_storage_s3_compatible_access_key
string
Google Cloud Storage: S3-compatible Access Key.
backblaze_b2_s3_endpoint
string
Backblaze B2 Cloud Storage: S3 Endpoint
backblaze_b2_bucket
string
Backblaze B2 Cloud Storage: Bucket name
wasabi_bucket
string
Wasabi: Bucket name
wasabi_region
string
Wasabi: Region
wasabi_access_key
string
Wasabi: Access Key.
auth_status
string
Either in_setup or complete
Possible values: not_applicable, in_setup, complete, reauthenticate
auth_account_name
string
Describes the authorized account
one_drive_account_type
string
OneDrive: Either personal or business_other account types
Possible values: personal, business_other
sharepoint_tenant_id
string
SharePoint: Microsoft Entra tenant ID for app-only authentication.
sharepoint_client_id
string
SharePoint: Microsoft Entra application client ID for app-only authentication.
sharepoint_app_authentication
boolean
SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
sharepoint_app_credential_type
string
SharePoint: App-only credential type. Either secret or certificate.
sharepoint_site_url
string
SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
azure_blob_storage_account
string
Azure Blob Storage: Account name
azure_blob_storage_container
string
Azure Blob Storage: Container name
azure_blob_storage_hierarchical_namespace
boolean
Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
azure_blob_storage_dns_suffix
string
Azure Blob Storage: Custom DNS suffix
azure_files_storage_account
string
Azure Files: Storage Account name
azure_files_storage_share_name
string
Azure Files: Storage Share name
azure_files_storage_dns_suffix
string
Azure Files: Custom DNS suffix
s3_compatible_bucket
string
S3-compatible: Bucket name
s3_compatible_endpoint
string
S3-compatible: endpoint
s3_compatible_region
string
S3-compatible: region
s3_compatible_virtual_hosted_style
boolean
S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
s3_compatible_access_key
string
S3-compatible: Access Key
enable_dedicated_ips
boolean
true if remote server only accepts connections from dedicated IPs
files_agent_permission_set
string
Local permissions for files agent. read_only, write_only, or read_write
Possible values: read_write, read_only, write_only
files_agent_root
string
Agent local root path
files_agent_api_token
string
Files Agent API Token
files_agent_version
string
Files Agent version
files_agent_up_to_date
boolean
If true, the Files Agent is up to date.
files_agent_latest_version
string
Latest available Files Agent version
files_agent_supports_push_updates
boolean
Files Agent supports receiving push updates
direct_transfer_available
boolean
Whether the Files Agent Proxy recently validated a direct transfer connection. true means a direct connection was recently validated (actual availability can vary by client network), false means direct transfers are enabled but not currently available, and null means direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server.
outbound_agent_id
int64
Route traffic to outbound on a files-agent
filebase_bucket
string
Filebase: Bucket name
filebase_access_key
string
Filebase: Access Key.
files_api_key_prefix
string
Files.com direct link: paired API key prefix.
cloudflare_bucket
string
Cloudflare: Bucket name
cloudflare_access_key
string
Cloudflare: Access Key.
cloudflare_endpoint
string
Cloudflare: endpoint
dropbox_teams
boolean
Dropbox: If true, list Team folders in root?
linode_bucket
string
Linode: Bucket name
linode_access_key
string
Linode: Access Key
linode_region
string
Linode: region
supports_versioning
boolean
If true, this remote server supports file versioning. This value is determined automatically by Files.com.