1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getRemoteServer
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A RemoteServer is a specific type of Behavior called remoteServerSync.

    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 serverCertificate.

    SFTP Servers require that you specify their hostname, port, username, password or privateKey, and a value for ssl. Optionally, provide serverCertificate, privateKeyPassphrase.

    S3 Buckets require that you specify their s3Bucket name, and s3Region. Optionally provide a awsAccessKey, and awsSecretKey. 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 s3CompatibleBucket, s3CompatibleEndpoint, s3CompatibleAccessKey, and s3CompatibleSecretKey. Optionally provide s3CompatibleVirtualHostedStyle to use virtual-hosted-style URLs instead of path-style URLs.

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

    • for JSON authentication: googleCloudStorageProjectId, and googleCloudStorageCredentialsJson

    • for HMAC (S3-Compatible) authentication: googleCloudStorageS3CompatibleAccessKey, and googleCloudStorageS3CompatibleSecretKey

    • for OAuth authentication: googleCloudStorageOauthScope, then follow the authSetupLink and login with Google

    Wasabi requires wasabiBucket, wasabiRegion, wasabiAccessKey, and wasabiSecretKey.

    Backblaze B2 Cloud Storage backblazeB2Bucket, backblazeB2S3Endpoint, backblazeB2ApplicationKey, and backblazeB2KeyId. (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 authSetupLink and login with Microsoft.

    SharePoint supports delegated authentication through authSetupLink, or app-only authentication with sharepointTenantId, sharepointClientId, and either sharepointClientSecret or sharepointClientCertificate. Set sharepointSiteUrl to scope the remote server to a site granted through Microsoft Graph Sites.Selected; leave it blank to browse all sites.

    Box follow the authSetupLink and login with Box.

    Dropbox specify if dropboxTeams then follow the authSetupLink and login with Dropbox.

    Google Drive follow the authSetupLink and login with Google.

    Azure Blob Storage azureBlobStorageAccount, azureBlobStorageContainer, azureBlobStorageAccessKey, azureBlobStorageSasToken, azureBlobStorageDnsSuffix

    Azure File Storage azureFilesStorageAccount, azureFilesStorageAccessKey, azureFilesStorageShareName, azureFilesStorageDnsSuffix

    Filebase requires filebaseBucket, filebaseAccessKey, and filebaseSecretKey.

    Cloudflare requires cloudflareBucket, cloudflareAccessKey, cloudflareSecretKey and cloudflareEndpoint.

    Linode requires linodeBucket, linodeAccessKey, linodeSecretKey and linodeRegion.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleRemoteServer = filescom.getRemoteServer({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_remote_server = filescom.get_remote_server(id=1)
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.GetRemoteServer(ctx, &filescom.LookupRemoteServerArgs{
    			Id: 1,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleRemoteServer = Filescom.GetRemoteServer.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetRemoteServerArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var exampleRemoteServer = FilescomFunctions.getRemoteServer(GetRemoteServerArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleRemoteServer:
        fn::invoke:
          function: filescom:getRemoteServer
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getremoteserver" "exampleRemoteServer" {
      id = 1
    }
    

    Using getRemoteServer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRemoteServer(args: GetRemoteServerArgs, opts?: InvokeOptions): Promise<GetRemoteServerResult>
    function getRemoteServerOutput(args: GetRemoteServerOutputArgs, opts?: InvokeOutputOptions): Output<GetRemoteServerResult>
    def get_remote_server(id: Optional[int] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRemoteServerResult
    def get_remote_server_output(id: pulumi.Input[Optional[int]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetRemoteServerResult]
    func LookupRemoteServer(ctx *Context, args *LookupRemoteServerArgs, opts ...InvokeOption) (*LookupRemoteServerResult, error)
    func LookupRemoteServerOutput(ctx *Context, args *LookupRemoteServerOutputArgs, opts ...InvokeOption) LookupRemoteServerResultOutput

    > Note: This function is named LookupRemoteServer in the Go SDK.

    public static class GetRemoteServer 
    {
        public static Task<GetRemoteServerResult> InvokeAsync(GetRemoteServerArgs args, InvokeOptions? opts = null)
        public static Output<GetRemoteServerResult> Invoke(GetRemoteServerInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRemoteServerResult> Invoke(GetRemoteServerInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRemoteServerResult> getRemoteServer(GetRemoteServerArgs args, InvokeOptions options)
    public static Output<GetRemoteServerResult> getRemoteServer(GetRemoteServerArgs args, InvokeOptions options)
    public static Output<GetRemoteServerResult> getRemoteServer(GetRemoteServerArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getRemoteServer:getRemoteServer
      arguments:
        # arguments dictionary
    data "filescom_get_remote_server" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Remote Server ID
    Id int
    Remote Server ID
    id number
    Remote Server ID
    id Integer
    Remote Server ID
    id number
    Remote Server ID
    id int
    Remote Server ID
    id Number
    Remote Server ID

    getRemoteServer Result

    The following output properties are available:

    AllowRelativePaths bool
    Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
    AuthAccountName string
    Describes the authorized account
    AuthStatus string
    Either inSetup or complete
    AuthenticationMethod string
    Type of authentication method to use
    AwsAccessKey string
    AWS Access Key.
    AzureBlobStorageAccount string
    Azure Blob Storage: Account name
    AzureBlobStorageContainer string
    Azure Blob Storage: Container name
    AzureBlobStorageDnsSuffix string
    Azure Blob Storage: Custom DNS suffix
    AzureBlobStorageHierarchicalNamespace bool
    Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
    AzureFilesStorageAccount string
    Azure Files: Storage Account name
    AzureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    AzureFilesStorageShareName string
    Azure Files: Storage Share name
    BackblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    BackblazeB2S3Endpoint string
    Backblaze B2 Cloud Storage: S3 Endpoint
    BufferUploads 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.
    CloudflareAccessKey string
    Cloudflare: Access Key.
    CloudflareBucket string
    Cloudflare: Bucket name
    CloudflareEndpoint string
    Cloudflare: endpoint
    Description string
    Internal description for your reference
    DirectTransferAvailable bool
    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.
    Disabled bool
    If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
    DropboxTeams bool
    Dropbox: If true, list Team folders in root?
    EnableDedicatedIps bool
    true if remote server only accepts connections from dedicated IPs
    FilebaseAccessKey string
    Filebase: Access Key.
    FilebaseBucket string
    Filebase: Bucket name
    FilesAgentApiToken string
    Files Agent API Token
    FilesAgentLatestVersion string
    Latest available Files Agent version
    FilesAgentPermissionSet string
    Local permissions for files agent. readonly, writeonly, or read_write
    FilesAgentRoot string
    Agent local root path
    FilesAgentSupportsPushUpdates bool
    Files Agent supports receiving push updates
    FilesAgentUpToDate bool
    If true, the Files Agent is up to date.
    FilesAgentVersion string
    Files Agent version
    FilesApiKeyPrefix string
    Files.com direct link: paired API key prefix.
    GoogleCloudStorageAuthenticationMethod string
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    GoogleCloudStorageBucket string
    Google Cloud Storage: Bucket Name
    GoogleCloudStorageOauthScope string
    Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    GoogleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    Hostname string
    Hostname or IP address
    Id int
    Remote Server ID
    LinodeAccessKey string
    Linode: Access Key
    LinodeBucket string
    Linode: Bucket name
    LinodeRegion string
    Linode: region
    MaxConnections int
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
    Name string
    Internal name for your reference
    OneDriveAccountType string
    OneDrive: Either personal or businessOther account types
    OutboundAgentId int
    Route traffic to outbound on a files-agent
    PinToSiteRegion bool
    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.
    PinnedRegion string
    If set, all communications with this remote server are made through the provided region.
    Port int
    Port for remote server.
    RemoteHomePath string
    Initial home folder on remote server
    RemoteServerCredentialId int
    ID of Remote Server Credential, if applicable.
    S3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    S3AssumeRoleDurationSeconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    S3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    S3Bucket string
    S3 bucket name
    S3CompatibleAccessKey string
    S3-compatible: Access Key
    S3CompatibleBucket string
    S3-compatible: Bucket name
    S3CompatibleEndpoint string
    S3-compatible: endpoint
    S3CompatibleRegion string
    S3-compatible: region
    S3CompatibleVirtualHostedStyle bool
    S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
    S3Region string
    S3 region
    ServerCertificate string
    Remote server certificate
    ServerHostKey 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
    ServerType string
    Remote server type.
    SharepointAppAuthentication bool
    SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
    SharepointAppCredentialType string
    SharePoint: App-only credential type. Either secret or certificate.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointSiteUrl string
    SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
    SharepointTenantId string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    Ssl string
    Should we require SSL?
    SupportsVersioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    UploadStagingPath 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.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WasabiBucket string
    Wasabi: Bucket name
    WasabiRegion string
    Wasabi: Region
    WorkspaceId int
    Workspace ID (0 for default workspace)
    AllowRelativePaths bool
    Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
    AuthAccountName string
    Describes the authorized account
    AuthStatus string
    Either inSetup or complete
    AuthenticationMethod string
    Type of authentication method to use
    AwsAccessKey string
    AWS Access Key.
    AzureBlobStorageAccount string
    Azure Blob Storage: Account name
    AzureBlobStorageContainer string
    Azure Blob Storage: Container name
    AzureBlobStorageDnsSuffix string
    Azure Blob Storage: Custom DNS suffix
    AzureBlobStorageHierarchicalNamespace bool
    Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
    AzureFilesStorageAccount string
    Azure Files: Storage Account name
    AzureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    AzureFilesStorageShareName string
    Azure Files: Storage Share name
    BackblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    BackblazeB2S3Endpoint string
    Backblaze B2 Cloud Storage: S3 Endpoint
    BufferUploads 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.
    CloudflareAccessKey string
    Cloudflare: Access Key.
    CloudflareBucket string
    Cloudflare: Bucket name
    CloudflareEndpoint string
    Cloudflare: endpoint
    Description string
    Internal description for your reference
    DirectTransferAvailable bool
    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.
    Disabled bool
    If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
    DropboxTeams bool
    Dropbox: If true, list Team folders in root?
    EnableDedicatedIps bool
    true if remote server only accepts connections from dedicated IPs
    FilebaseAccessKey string
    Filebase: Access Key.
    FilebaseBucket string
    Filebase: Bucket name
    FilesAgentApiToken string
    Files Agent API Token
    FilesAgentLatestVersion string
    Latest available Files Agent version
    FilesAgentPermissionSet string
    Local permissions for files agent. readonly, writeonly, or read_write
    FilesAgentRoot string
    Agent local root path
    FilesAgentSupportsPushUpdates bool
    Files Agent supports receiving push updates
    FilesAgentUpToDate bool
    If true, the Files Agent is up to date.
    FilesAgentVersion string
    Files Agent version
    FilesApiKeyPrefix string
    Files.com direct link: paired API key prefix.
    GoogleCloudStorageAuthenticationMethod string
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    GoogleCloudStorageBucket string
    Google Cloud Storage: Bucket Name
    GoogleCloudStorageOauthScope string
    Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    GoogleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    Hostname string
    Hostname or IP address
    Id int
    Remote Server ID
    LinodeAccessKey string
    Linode: Access Key
    LinodeBucket string
    Linode: Bucket name
    LinodeRegion string
    Linode: region
    MaxConnections int
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
    Name string
    Internal name for your reference
    OneDriveAccountType string
    OneDrive: Either personal or businessOther account types
    OutboundAgentId int
    Route traffic to outbound on a files-agent
    PinToSiteRegion bool
    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.
    PinnedRegion string
    If set, all communications with this remote server are made through the provided region.
    Port int
    Port for remote server.
    RemoteHomePath string
    Initial home folder on remote server
    RemoteServerCredentialId int
    ID of Remote Server Credential, if applicable.
    S3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    S3AssumeRoleDurationSeconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    S3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    S3Bucket string
    S3 bucket name
    S3CompatibleAccessKey string
    S3-compatible: Access Key
    S3CompatibleBucket string
    S3-compatible: Bucket name
    S3CompatibleEndpoint string
    S3-compatible: endpoint
    S3CompatibleRegion string
    S3-compatible: region
    S3CompatibleVirtualHostedStyle bool
    S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
    S3Region string
    S3 region
    ServerCertificate string
    Remote server certificate
    ServerHostKey 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
    ServerType string
    Remote server type.
    SharepointAppAuthentication bool
    SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
    SharepointAppCredentialType string
    SharePoint: App-only credential type. Either secret or certificate.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointSiteUrl string
    SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
    SharepointTenantId string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    Ssl string
    Should we require SSL?
    SupportsVersioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    UploadStagingPath 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.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WasabiBucket string
    Wasabi: Bucket name
    WasabiRegion string
    Wasabi: Region
    WorkspaceId int
    Workspace ID (0 for default workspace)
    allow_relative_paths bool
    Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
    auth_account_name string
    Describes the authorized account
    auth_status string
    Either inSetup or complete
    authentication_method string
    Type of authentication method to use
    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 bool
    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.
    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
    direct_transfer_available bool
    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.
    disabled bool
    If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
    dropbox_teams bool
    Dropbox: If true, list Team folders in root?
    enable_dedicated_ips bool
    true if remote server only accepts connections from dedicated IPs
    filebase_access_key string
    Filebase: Access Key.
    filebase_bucket string
    Filebase: Bucket name
    files_agent_api_token string
    Files Agent API Token
    files_agent_latest_version string
    Latest available Files Agent version
    files_agent_permission_set string
    Local permissions for files agent. readonly, writeonly, or read_write
    files_agent_root string
    Agent local root path
    files_agent_supports_push_updates bool
    Files Agent supports receiving push updates
    files_agent_up_to_date bool
    If true, the Files Agent is up to date.
    files_agent_version string
    Files Agent version
    files_api_key_prefix string
    Files.com direct link: paired API key prefix.
    google_cloud_storage_authentication_method string
    Google Cloud Storage: Authentication method. Can be json, hmac, or 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.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    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
    id number
    Remote Server ID
    linode_access_key string
    Linode: Access Key
    linode_bucket string
    Linode: Bucket name
    linode_region string
    Linode: region
    max_connections number
    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 businessOther account types
    outbound_agent_id number
    Route traffic to outbound on a files-agent
    pin_to_site_region bool
    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.
    port number
    Port for remote server.
    remote_home_path string
    Initial home folder on remote server
    remote_server_credential_id number
    ID of Remote Server Credential, if applicable.
    s3_assume_role_arn string
    AWS IAM Role ARN for AssumeRole authentication.
    s3_assume_role_duration_seconds number
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3_assume_role_external_id string
    External ID for AssumeRole authentication.
    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 bool
    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
    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.
    sharepoint_app_authentication bool
    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_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?
    supports_versioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    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.
    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 number
    Workspace ID (0 for default workspace)
    allowRelativePaths 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.
    authAccountName String
    Describes the authorized account
    authStatus String
    Either inSetup or complete
    authenticationMethod String
    Type of authentication method to use
    awsAccessKey String
    AWS Access Key.
    azureBlobStorageAccount String
    Azure Blob Storage: Account name
    azureBlobStorageContainer String
    Azure Blob Storage: Container name
    azureBlobStorageDnsSuffix String
    Azure Blob Storage: Custom DNS suffix
    azureBlobStorageHierarchicalNamespace Boolean
    Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
    azureFilesStorageAccount String
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix String
    Azure Files: Custom DNS suffix
    azureFilesStorageShareName String
    Azure Files: Storage Share name
    backblazeB2Bucket String
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2S3Endpoint String
    Backblaze B2 Cloud Storage: S3 Endpoint
    bufferUploads 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.
    cloudflareAccessKey String
    Cloudflare: Access Key.
    cloudflareBucket String
    Cloudflare: Bucket name
    cloudflareEndpoint String
    Cloudflare: endpoint
    description String
    Internal description for your reference
    directTransferAvailable 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.
    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.
    dropboxTeams Boolean
    Dropbox: If true, list Team folders in root?
    enableDedicatedIps Boolean
    true if remote server only accepts connections from dedicated IPs
    filebaseAccessKey String
    Filebase: Access Key.
    filebaseBucket String
    Filebase: Bucket name
    filesAgentApiToken String
    Files Agent API Token
    filesAgentLatestVersion String
    Latest available Files Agent version
    filesAgentPermissionSet String
    Local permissions for files agent. readonly, writeonly, or read_write
    filesAgentRoot String
    Agent local root path
    filesAgentSupportsPushUpdates Boolean
    Files Agent supports receiving push updates
    filesAgentUpToDate Boolean
    If true, the Files Agent is up to date.
    filesAgentVersion String
    Files Agent version
    filesApiKeyPrefix String
    Files.com direct link: paired API key prefix.
    googleCloudStorageAuthenticationMethod String
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    googleCloudStorageBucket String
    Google Cloud Storage: Bucket Name
    googleCloudStorageOauthScope String
    Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    googleCloudStorageProjectId String
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    hostname String
    Hostname or IP address
    id Integer
    Remote Server ID
    linodeAccessKey String
    Linode: Access Key
    linodeBucket String
    Linode: Bucket name
    linodeRegion String
    Linode: region
    maxConnections Integer
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
    name String
    Internal name for your reference
    oneDriveAccountType String
    OneDrive: Either personal or businessOther account types
    outboundAgentId Integer
    Route traffic to outbound on a files-agent
    pinToSiteRegion 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.
    pinnedRegion String
    If set, all communications with this remote server are made through the provided region.
    port Integer
    Port for remote server.
    remoteHomePath String
    Initial home folder on remote server
    remoteServerCredentialId Integer
    ID of Remote Server Credential, if applicable.
    s3AssumeRoleArn String
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds Integer
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3AssumeRoleExternalId String
    External ID for AssumeRole authentication.
    s3Bucket String
    S3 bucket name
    s3CompatibleAccessKey String
    S3-compatible: Access Key
    s3CompatibleBucket String
    S3-compatible: Bucket name
    s3CompatibleEndpoint String
    S3-compatible: endpoint
    s3CompatibleRegion String
    S3-compatible: region
    s3CompatibleVirtualHostedStyle Boolean
    S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
    s3Region String
    S3 region
    serverCertificate String
    Remote server certificate
    serverHostKey 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
    serverType String
    Remote server type.
    sharepointAppAuthentication Boolean
    SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
    sharepointAppCredentialType String
    SharePoint: App-only credential type. Either secret or certificate.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointSiteUrl String
    SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
    sharepointTenantId String
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    ssl String
    Should we require SSL?
    supportsVersioning Boolean
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    uploadStagingPath 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.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    wasabiBucket String
    Wasabi: Bucket name
    wasabiRegion String
    Wasabi: Region
    workspaceId Integer
    Workspace ID (0 for default workspace)
    allowRelativePaths 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.
    authAccountName string
    Describes the authorized account
    authStatus string
    Either inSetup or complete
    authenticationMethod string
    Type of authentication method to use
    awsAccessKey string
    AWS Access Key.
    azureBlobStorageAccount string
    Azure Blob Storage: Account name
    azureBlobStorageContainer string
    Azure Blob Storage: Container name
    azureBlobStorageDnsSuffix string
    Azure Blob Storage: Custom DNS suffix
    azureBlobStorageHierarchicalNamespace boolean
    Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
    azureFilesStorageAccount string
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    azureFilesStorageShareName string
    Azure Files: Storage Share name
    backblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2S3Endpoint string
    Backblaze B2 Cloud Storage: S3 Endpoint
    bufferUploads 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.
    cloudflareAccessKey string
    Cloudflare: Access Key.
    cloudflareBucket string
    Cloudflare: Bucket name
    cloudflareEndpoint string
    Cloudflare: endpoint
    description string
    Internal description for your reference
    directTransferAvailable 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.
    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.
    dropboxTeams boolean
    Dropbox: If true, list Team folders in root?
    enableDedicatedIps boolean
    true if remote server only accepts connections from dedicated IPs
    filebaseAccessKey string
    Filebase: Access Key.
    filebaseBucket string
    Filebase: Bucket name
    filesAgentApiToken string
    Files Agent API Token
    filesAgentLatestVersion string
    Latest available Files Agent version
    filesAgentPermissionSet string
    Local permissions for files agent. readonly, writeonly, or read_write
    filesAgentRoot string
    Agent local root path
    filesAgentSupportsPushUpdates boolean
    Files Agent supports receiving push updates
    filesAgentUpToDate boolean
    If true, the Files Agent is up to date.
    filesAgentVersion string
    Files Agent version
    filesApiKeyPrefix string
    Files.com direct link: paired API key prefix.
    googleCloudStorageAuthenticationMethod string
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    googleCloudStorageBucket string
    Google Cloud Storage: Bucket Name
    googleCloudStorageOauthScope string
    Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    googleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    hostname string
    Hostname or IP address
    id number
    Remote Server ID
    linodeAccessKey string
    Linode: Access Key
    linodeBucket string
    Linode: Bucket name
    linodeRegion string
    Linode: region
    maxConnections number
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
    name string
    Internal name for your reference
    oneDriveAccountType string
    OneDrive: Either personal or businessOther account types
    outboundAgentId number
    Route traffic to outbound on a files-agent
    pinToSiteRegion 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.
    pinnedRegion string
    If set, all communications with this remote server are made through the provided region.
    port number
    Port for remote server.
    remoteHomePath string
    Initial home folder on remote server
    remoteServerCredentialId number
    ID of Remote Server Credential, if applicable.
    s3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds number
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    s3Bucket string
    S3 bucket name
    s3CompatibleAccessKey string
    S3-compatible: Access Key
    s3CompatibleBucket string
    S3-compatible: Bucket name
    s3CompatibleEndpoint string
    S3-compatible: endpoint
    s3CompatibleRegion string
    S3-compatible: region
    s3CompatibleVirtualHostedStyle boolean
    S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
    s3Region string
    S3 region
    serverCertificate string
    Remote server certificate
    serverHostKey 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
    serverType string
    Remote server type.
    sharepointAppAuthentication boolean
    SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
    sharepointAppCredentialType string
    SharePoint: App-only credential type. Either secret or certificate.
    sharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointSiteUrl string
    SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
    sharepointTenantId string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    ssl string
    Should we require SSL?
    supportsVersioning boolean
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    uploadStagingPath 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.
    username string
    Remote server username.
    wasabiAccessKey string
    Wasabi: Access Key.
    wasabiBucket string
    Wasabi: Bucket name
    wasabiRegion string
    Wasabi: Region
    workspaceId number
    Workspace ID (0 for default workspace)
    allow_relative_paths bool
    Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
    auth_account_name str
    Describes the authorized account
    auth_status str
    Either inSetup or complete
    authentication_method str
    Type of authentication method to use
    aws_access_key str
    AWS Access Key.
    azure_blob_storage_account str
    Azure Blob Storage: Account name
    azure_blob_storage_container str
    Azure Blob Storage: Container name
    azure_blob_storage_dns_suffix str
    Azure Blob Storage: Custom DNS suffix
    azure_blob_storage_hierarchical_namespace bool
    Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
    azure_files_storage_account str
    Azure Files: Storage Account name
    azure_files_storage_dns_suffix str
    Azure Files: Custom DNS suffix
    azure_files_storage_share_name str
    Azure Files: Storage Share name
    backblaze_b2_bucket str
    Backblaze B2 Cloud Storage: Bucket name
    backblaze_b2_s3_endpoint str
    Backblaze B2 Cloud Storage: S3 Endpoint
    buffer_uploads str
    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.
    cloudflare_access_key str
    Cloudflare: Access Key.
    cloudflare_bucket str
    Cloudflare: Bucket name
    cloudflare_endpoint str
    Cloudflare: endpoint
    description str
    Internal description for your reference
    direct_transfer_available bool
    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.
    disabled bool
    If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
    dropbox_teams bool
    Dropbox: If true, list Team folders in root?
    enable_dedicated_ips bool
    true if remote server only accepts connections from dedicated IPs
    filebase_access_key str
    Filebase: Access Key.
    filebase_bucket str
    Filebase: Bucket name
    files_agent_api_token str
    Files Agent API Token
    files_agent_latest_version str
    Latest available Files Agent version
    files_agent_permission_set str
    Local permissions for files agent. readonly, writeonly, or read_write
    files_agent_root str
    Agent local root path
    files_agent_supports_push_updates bool
    Files Agent supports receiving push updates
    files_agent_up_to_date bool
    If true, the Files Agent is up to date.
    files_agent_version str
    Files Agent version
    files_api_key_prefix str
    Files.com direct link: paired API key prefix.
    google_cloud_storage_authentication_method str
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    google_cloud_storage_bucket str
    Google Cloud Storage: Bucket Name
    google_cloud_storage_oauth_scope str
    Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    google_cloud_storage_project_id str
    Google Cloud Storage: Project ID
    google_cloud_storage_s3_compatible_access_key str
    Google Cloud Storage: S3-compatible Access Key.
    hostname str
    Hostname or IP address
    id int
    Remote Server ID
    linode_access_key str
    Linode: Access Key
    linode_bucket str
    Linode: Bucket name
    linode_region str
    Linode: region
    max_connections int
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
    name str
    Internal name for your reference
    one_drive_account_type str
    OneDrive: Either personal or businessOther account types
    outbound_agent_id int
    Route traffic to outbound on a files-agent
    pin_to_site_region bool
    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 str
    If set, all communications with this remote server are made through the provided region.
    port int
    Port for remote server.
    remote_home_path str
    Initial home folder on remote server
    remote_server_credential_id int
    ID of Remote Server Credential, if applicable.
    s3_assume_role_arn str
    AWS IAM Role ARN for AssumeRole authentication.
    s3_assume_role_duration_seconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3_assume_role_external_id str
    External ID for AssumeRole authentication.
    s3_bucket str
    S3 bucket name
    s3_compatible_access_key str
    S3-compatible: Access Key
    s3_compatible_bucket str
    S3-compatible: Bucket name
    s3_compatible_endpoint str
    S3-compatible: endpoint
    s3_compatible_region str
    S3-compatible: region
    s3_compatible_virtual_hosted_style bool
    S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
    s3_region str
    S3 region
    server_certificate str
    Remote server certificate
    server_host_key str
    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 str
    Remote server type.
    sharepoint_app_authentication bool
    SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
    sharepoint_app_credential_type str
    SharePoint: App-only credential type. Either secret or certificate.
    sharepoint_client_id str
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_site_url str
    SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
    sharepoint_tenant_id str
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    ssl str
    Should we require SSL?
    supports_versioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    upload_staging_path str
    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.
    username str
    Remote server username.
    wasabi_access_key str
    Wasabi: Access Key.
    wasabi_bucket str
    Wasabi: Bucket name
    wasabi_region str
    Wasabi: Region
    workspace_id int
    Workspace ID (0 for default workspace)
    allowRelativePaths 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.
    authAccountName String
    Describes the authorized account
    authStatus String
    Either inSetup or complete
    authenticationMethod String
    Type of authentication method to use
    awsAccessKey String
    AWS Access Key.
    azureBlobStorageAccount String
    Azure Blob Storage: Account name
    azureBlobStorageContainer String
    Azure Blob Storage: Container name
    azureBlobStorageDnsSuffix String
    Azure Blob Storage: Custom DNS suffix
    azureBlobStorageHierarchicalNamespace Boolean
    Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
    azureFilesStorageAccount String
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix String
    Azure Files: Custom DNS suffix
    azureFilesStorageShareName String
    Azure Files: Storage Share name
    backblazeB2Bucket String
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2S3Endpoint String
    Backblaze B2 Cloud Storage: S3 Endpoint
    bufferUploads 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.
    cloudflareAccessKey String
    Cloudflare: Access Key.
    cloudflareBucket String
    Cloudflare: Bucket name
    cloudflareEndpoint String
    Cloudflare: endpoint
    description String
    Internal description for your reference
    directTransferAvailable 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.
    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.
    dropboxTeams Boolean
    Dropbox: If true, list Team folders in root?
    enableDedicatedIps Boolean
    true if remote server only accepts connections from dedicated IPs
    filebaseAccessKey String
    Filebase: Access Key.
    filebaseBucket String
    Filebase: Bucket name
    filesAgentApiToken String
    Files Agent API Token
    filesAgentLatestVersion String
    Latest available Files Agent version
    filesAgentPermissionSet String
    Local permissions for files agent. readonly, writeonly, or read_write
    filesAgentRoot String
    Agent local root path
    filesAgentSupportsPushUpdates Boolean
    Files Agent supports receiving push updates
    filesAgentUpToDate Boolean
    If true, the Files Agent is up to date.
    filesAgentVersion String
    Files Agent version
    filesApiKeyPrefix String
    Files.com direct link: paired API key prefix.
    googleCloudStorageAuthenticationMethod String
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    googleCloudStorageBucket String
    Google Cloud Storage: Bucket Name
    googleCloudStorageOauthScope String
    Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.readonly or https://www.googleapis.com/auth/devstorage.readwrite.
    googleCloudStorageProjectId String
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    hostname String
    Hostname or IP address
    id Number
    Remote Server ID
    linodeAccessKey String
    Linode: Access Key
    linodeBucket String
    Linode: Bucket name
    linodeRegion String
    Linode: region
    maxConnections Number
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
    name String
    Internal name for your reference
    oneDriveAccountType String
    OneDrive: Either personal or businessOther account types
    outboundAgentId Number
    Route traffic to outbound on a files-agent
    pinToSiteRegion 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.
    pinnedRegion String
    If set, all communications with this remote server are made through the provided region.
    port Number
    Port for remote server.
    remoteHomePath String
    Initial home folder on remote server
    remoteServerCredentialId Number
    ID of Remote Server Credential, if applicable.
    s3AssumeRoleArn String
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds Number
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3AssumeRoleExternalId String
    External ID for AssumeRole authentication.
    s3Bucket String
    S3 bucket name
    s3CompatibleAccessKey String
    S3-compatible: Access Key
    s3CompatibleBucket String
    S3-compatible: Bucket name
    s3CompatibleEndpoint String
    S3-compatible: endpoint
    s3CompatibleRegion String
    S3-compatible: region
    s3CompatibleVirtualHostedStyle Boolean
    S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
    s3Region String
    S3 region
    serverCertificate String
    Remote server certificate
    serverHostKey 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
    serverType String
    Remote server type.
    sharepointAppAuthentication Boolean
    SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
    sharepointAppCredentialType String
    SharePoint: App-only credential type. Either secret or certificate.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointSiteUrl String
    SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
    sharepointTenantId String
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    ssl String
    Should we require SSL?
    supportsVersioning Boolean
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    uploadStagingPath 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.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    wasabiBucket String
    Wasabi: Bucket name
    wasabiRegion String
    Wasabi: Region
    workspaceId Number
    Workspace ID (0 for default workspace)

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial