Remote Server Configuration Files
A RemoteServerConfigurationFile is a configuration file (required for some Remote Server integrations, such as the Files.com Agent).
Download configuration file (required for some Remote Server integrations, such as the Files.com Agent)
SDK Method
remoteserver.FindConfigurationFile()
Return Object
RemoteServerConfigurationFile
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a user with an Integration-Centric file system layout managing their own Remote Servers.
RemoteServerFindConfigurationFileParams Fields
| Field | Description |
|---|---|
| Id int64 Required | Remote Server ID. |
The RemoteServerConfigurationFile Object
Some of the methods above return a RemoteServerConfigurationFile object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| Id int64 | The remote server ID of the agent |
| PermissionSet string | The permission set for the agent ['read_write', 'read_only', 'write_only'] |
| PrivateKey string | The private key for the agent |
| Subdomain string | Files.com subdomain site name |
| Root string | The root directory for the agent |
| NodeName string | Optional customer-facing name for this Agent installation |
| FollowLinks boolean | Follow symlinks when traversing directories |
| PreferProtocol string | Preferred network protocol ['udp', 'tcp'] (default udp) |
| Dns string | DNS lookup method ['auto','doh','system'] (default auto) |
| ProxyAllOutbound boolean | Proxy all outbound traffic through files.com proxy server |
| EndpointOverride string | Custom site endpoint URL |
| LogFile string | Log file name and location |
| LogLevel string | Log level for the agent logs ['debug', 'info', 'warn', 'error', 'fatal'] (default info) |
| LogRotateNum int64 | Log route for agent logs. (default 5) |
| LogRotateSize int64 | Log route size in MB for agent logs. (default 20) |
| OverrideMaxConcurrentJobs int64 | Maximum number of concurrent jobs (default 500) |
| GracefulShutdownTimeout int64 | Graceful shutdown timeout in seconds (default 15) |
| TransferRateLimit string | 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' |
| AutoUpdatePolicy string | Auto update policy ['manual_trigger', 'critical_only', 'always', 'never'] (default always) |