FIfiles
remote_servers
Remote Server Configuration Files

Download configuration file (required for some Remote Server integrations, such as the Files.com Agent)

Changed on

Download configuration file (required for some Remote Server integrations, such as the Files.com Agent)

get/remote_servers/{id}/configuration_file

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/remote_servers/{id}/configuration_file
  • Auth
    none declared

Path parameters

idinteger required

Remote Server ID.

Response

The RemoteServers object.

idinteger

The remote server ID of the agent

permission_setstring

The permission set for the agent ['read_write', 'read_only', 'write_only']

private_keystring

The private key for the agent

subdomainstring

Files.com subdomain site name

rootstring

The root directory for the agent

node_namestring

Optional customer-facing name for this Agent installation

follow_linksboolean

Follow symlinks when traversing directories

prefer_protocolstring

Preferred network protocol ['udp', 'tcp'] (default udp)

dnsstring

DNS lookup method ['auto','doh','system'] (default auto)

proxy_all_outboundboolean

Proxy all outbound traffic through files.com proxy server

endpoint_overridestring

Custom site endpoint URL

log_filestring

Log file name and location

log_levelstring

Log level for the agent logs ['debug', 'info', 'warn', 'error', 'fatal'] (default info)

log_rotate_numinteger

Log route for agent logs. (default 5)

log_rotate_sizeinteger

Log route size in MB for agent logs. (default 20)

override_max_concurrent_jobsinteger

Maximum number of concurrent jobs (default 500)

graceful_shutdown_timeoutinteger

Graceful shutdown timeout in seconds (default 15)

transfer_rate_limitstring

File transfer (upload/download) rate limit <limit>-<period>, with the given periods:

  • 'S': second
  • 'M': minute
  • 'H': hour
  • 'D': day Examples:
  • 5 requests/second: '5-S'
  • 10 requests/minute: '10-M'
  • 1000 requests/hour: '1000-H'
  • 2000 requests/day: '2000-D'
auto_update_policystring

Auto update policy ['manual_trigger', 'critical_only', 'always', 'never'] (default always)

Example response

{
  "id": 1,
  "permission_set": "example",
  "private_key": "example",
  "subdomain": "example",
  "root": "C:\\Users\\",
  "node_name": "example",
  "follow_links": true,
  "prefer_protocol": "example",
  "dns": "example",
  "proxy_all_outbound": true,
  "endpoint_override": "example",
  "log_file": "example",
  "log_level": "example",
  "log_rotate_num": 1,
  "log_rotate_size": 1,
  "override_max_concurrent_jobs": 1,
  "graceful_shutdown_timeout": 1,
  "transfer_rate_limit": "example",
  "auto_update_policy": "example"
}

Changes