1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. RemoteServer
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 = new filescom.RemoteServer("example_remote_server", {
        userId: 1,
        resetAuthentication: false,
        allowRelativePaths: true,
        awsAccessKey: "example",
        azureBlobStorageAccount: "storage-account-name",
        azureBlobStorageContainer: "container-name",
        azureBlobStorageDnsSuffix: "usgovcloudapi.net",
        azureBlobStorageHierarchicalNamespace: true,
        azureFilesStorageAccount: "storage-account-name",
        azureFilesStorageDnsSuffix: "file.core.windows.net",
        azureFilesStorageShareName: "share-name",
        backblazeB2Bucket: "my-bucket",
        backblazeB2S3Endpoint: "s3.us-west-001.backblazeb2.com",
        bufferUploads: "example",
        cloudflareAccessKey: "example",
        cloudflareBucket: "my-bucket",
        cloudflareEndpoint: "https://<ACCOUNT_ID>.r2.cloudflarestorage.com",
        description: "More information or notes about my server",
        dropboxTeams: true,
        enableDedicatedIps: true,
        filebaseAccessKey: "example",
        filebaseBucket: "my-bucket",
        filesAgentPermissionSet: "read_write",
        filesAgentRoot: "example",
        filesAgentVersion: "example",
        outboundAgentId: 1,
        googleCloudStorageAuthenticationMethod: "json",
        googleCloudStorageBucket: "my-bucket",
        googleCloudStorageOauthScope: "https://www.googleapis.com/auth/devstorage.read_only",
        googleCloudStorageProjectId: "my-project",
        googleCloudStorageS3CompatibleAccessKey: "example",
        hostname: "remote-server.com",
        linodeAccessKey: "example",
        linodeBucket: "my-bucket",
        linodeRegion: "us-east-1",
        maxConnections: 1,
        name: "My Remote server",
        oneDriveAccountType: "personal",
        pinToSiteRegion: true,
        port: 1,
        uploadStagingPath: "/tmp/uploads",
        remoteServerCredentialId: 1,
        s3AssumeRoleArn: "example",
        s3AssumeRoleDurationSeconds: 1,
        s3Bucket: "my-bucket",
        s3CompatibleAccessKey: "example",
        s3CompatibleBucket: "my-bucket",
        s3CompatibleEndpoint: "mys3platform.com",
        s3CompatibleRegion: "us-east-1",
        s3CompatibleVirtualHostedStyle: true,
        s3Region: "us-east-1",
        serverCertificate: "require_match",
        serverHostKey: "[public key]",
        serverType: "s3",
        sharepointClientId: "00000000-0000-0000-0000-000000000000",
        sharepointSiteUrl: "https://example.sharepoint.com/sites/accounting",
        sharepointTenantId: "00000000-0000-0000-0000-000000000000",
        ssl: "if_available",
        username: "user",
        wasabiAccessKey: "example",
        wasabiBucket: "my-bucket",
        wasabiRegion: "us-west-1",
        workspaceId: 0,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_remote_server = filescom.RemoteServer("example_remote_server",
        user_id=1,
        reset_authentication=False,
        allow_relative_paths=True,
        aws_access_key="example",
        azure_blob_storage_account="storage-account-name",
        azure_blob_storage_container="container-name",
        azure_blob_storage_dns_suffix="usgovcloudapi.net",
        azure_blob_storage_hierarchical_namespace=True,
        azure_files_storage_account="storage-account-name",
        azure_files_storage_dns_suffix="file.core.windows.net",
        azure_files_storage_share_name="share-name",
        backblaze_b2_bucket="my-bucket",
        backblaze_b2_s3_endpoint="s3.us-west-001.backblazeb2.com",
        buffer_uploads="example",
        cloudflare_access_key="example",
        cloudflare_bucket="my-bucket",
        cloudflare_endpoint="https://<ACCOUNT_ID>.r2.cloudflarestorage.com",
        description="More information or notes about my server",
        dropbox_teams=True,
        enable_dedicated_ips=True,
        filebase_access_key="example",
        filebase_bucket="my-bucket",
        files_agent_permission_set="read_write",
        files_agent_root="example",
        files_agent_version="example",
        outbound_agent_id=1,
        google_cloud_storage_authentication_method="json",
        google_cloud_storage_bucket="my-bucket",
        google_cloud_storage_oauth_scope="https://www.googleapis.com/auth/devstorage.read_only",
        google_cloud_storage_project_id="my-project",
        google_cloud_storage_s3_compatible_access_key="example",
        hostname="remote-server.com",
        linode_access_key="example",
        linode_bucket="my-bucket",
        linode_region="us-east-1",
        max_connections=1,
        name="My Remote server",
        one_drive_account_type="personal",
        pin_to_site_region=True,
        port=1,
        upload_staging_path="/tmp/uploads",
        remote_server_credential_id=1,
        s3_assume_role_arn="example",
        s3_assume_role_duration_seconds=1,
        s3_bucket="my-bucket",
        s3_compatible_access_key="example",
        s3_compatible_bucket="my-bucket",
        s3_compatible_endpoint="mys3platform.com",
        s3_compatible_region="us-east-1",
        s3_compatible_virtual_hosted_style=True,
        s3_region="us-east-1",
        server_certificate="require_match",
        server_host_key="[public key]",
        server_type="s3",
        sharepoint_client_id="00000000-0000-0000-0000-000000000000",
        sharepoint_site_url="https://example.sharepoint.com/sites/accounting",
        sharepoint_tenant_id="00000000-0000-0000-0000-000000000000",
        ssl="if_available",
        username="user",
        wasabi_access_key="example",
        wasabi_bucket="my-bucket",
        wasabi_region="us-west-1",
        workspace_id=0)
    
    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.NewRemoteServer(ctx, "example_remote_server", &filescom.RemoteServerArgs{
    			UserId:                                  pulumi.Int(1),
    			ResetAuthentication:                     pulumi.Bool(false),
    			AllowRelativePaths:                      pulumi.Bool(true),
    			AwsAccessKey:                            pulumi.String("example"),
    			AzureBlobStorageAccount:                 pulumi.String("storage-account-name"),
    			AzureBlobStorageContainer:               pulumi.String("container-name"),
    			AzureBlobStorageDnsSuffix:               pulumi.String("usgovcloudapi.net"),
    			AzureBlobStorageHierarchicalNamespace:   pulumi.Bool(true),
    			AzureFilesStorageAccount:                pulumi.String("storage-account-name"),
    			AzureFilesStorageDnsSuffix:              pulumi.String("file.core.windows.net"),
    			AzureFilesStorageShareName:              pulumi.String("share-name"),
    			BackblazeB2Bucket:                       pulumi.String("my-bucket"),
    			BackblazeB2S3Endpoint:                   pulumi.String("s3.us-west-001.backblazeb2.com"),
    			BufferUploads:                           pulumi.String("example"),
    			CloudflareAccessKey:                     pulumi.String("example"),
    			CloudflareBucket:                        pulumi.String("my-bucket"),
    			CloudflareEndpoint:                      pulumi.String("https://<ACCOUNT_ID>.r2.cloudflarestorage.com"),
    			Description:                             pulumi.String("More information or notes about my server"),
    			DropboxTeams:                            pulumi.Bool(true),
    			EnableDedicatedIps:                      pulumi.Bool(true),
    			FilebaseAccessKey:                       pulumi.String("example"),
    			FilebaseBucket:                          pulumi.String("my-bucket"),
    			FilesAgentPermissionSet:                 pulumi.String("read_write"),
    			FilesAgentRoot:                          pulumi.String("example"),
    			FilesAgentVersion:                       pulumi.String("example"),
    			OutboundAgentId:                         pulumi.Int(1),
    			GoogleCloudStorageAuthenticationMethod:  pulumi.String("json"),
    			GoogleCloudStorageBucket:                pulumi.String("my-bucket"),
    			GoogleCloudStorageOauthScope:            pulumi.String("https://www.googleapis.com/auth/devstorage.read_only"),
    			GoogleCloudStorageProjectId:             pulumi.String("my-project"),
    			GoogleCloudStorageS3CompatibleAccessKey: pulumi.String("example"),
    			Hostname:                                pulumi.String("remote-server.com"),
    			LinodeAccessKey:                         pulumi.String("example"),
    			LinodeBucket:                            pulumi.String("my-bucket"),
    			LinodeRegion:                            pulumi.String("us-east-1"),
    			MaxConnections:                          pulumi.Int(1),
    			Name:                                    pulumi.String("My Remote server"),
    			OneDriveAccountType:                     pulumi.String("personal"),
    			PinToSiteRegion:                         pulumi.Bool(true),
    			Port:                                    pulumi.Int(1),
    			UploadStagingPath:                       pulumi.String("/tmp/uploads"),
    			RemoteServerCredentialId:                pulumi.Int(1),
    			S3AssumeRoleArn:                         pulumi.String("example"),
    			S3AssumeRoleDurationSeconds:             pulumi.Int(1),
    			S3Bucket:                                pulumi.String("my-bucket"),
    			S3CompatibleAccessKey:                   pulumi.String("example"),
    			S3CompatibleBucket:                      pulumi.String("my-bucket"),
    			S3CompatibleEndpoint:                    pulumi.String("mys3platform.com"),
    			S3CompatibleRegion:                      pulumi.String("us-east-1"),
    			S3CompatibleVirtualHostedStyle:          pulumi.Bool(true),
    			S3Region:                                pulumi.String("us-east-1"),
    			ServerCertificate:                       pulumi.String("require_match"),
    			ServerHostKey:                           pulumi.String("[public key]"),
    			ServerType:                              pulumi.String("s3"),
    			SharepointClientId:                      pulumi.String("00000000-0000-0000-0000-000000000000"),
    			SharepointSiteUrl:                       pulumi.String("https://example.sharepoint.com/sites/accounting"),
    			SharepointTenantId:                      pulumi.String("00000000-0000-0000-0000-000000000000"),
    			Ssl:                                     pulumi.String("if_available"),
    			Username:                                pulumi.String("user"),
    			WasabiAccessKey:                         pulumi.String("example"),
    			WasabiBucket:                            pulumi.String("my-bucket"),
    			WasabiRegion:                            pulumi.String("us-west-1"),
    			WorkspaceId:                             pulumi.Int(0),
    		})
    		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 = new Filescom.RemoteServer("example_remote_server", new()
        {
            UserId = 1,
            ResetAuthentication = false,
            AllowRelativePaths = true,
            AwsAccessKey = "example",
            AzureBlobStorageAccount = "storage-account-name",
            AzureBlobStorageContainer = "container-name",
            AzureBlobStorageDnsSuffix = "usgovcloudapi.net",
            AzureBlobStorageHierarchicalNamespace = true,
            AzureFilesStorageAccount = "storage-account-name",
            AzureFilesStorageDnsSuffix = "file.core.windows.net",
            AzureFilesStorageShareName = "share-name",
            BackblazeB2Bucket = "my-bucket",
            BackblazeB2S3Endpoint = "s3.us-west-001.backblazeb2.com",
            BufferUploads = "example",
            CloudflareAccessKey = "example",
            CloudflareBucket = "my-bucket",
            CloudflareEndpoint = "https://<ACCOUNT_ID>.r2.cloudflarestorage.com",
            Description = "More information or notes about my server",
            DropboxTeams = true,
            EnableDedicatedIps = true,
            FilebaseAccessKey = "example",
            FilebaseBucket = "my-bucket",
            FilesAgentPermissionSet = "read_write",
            FilesAgentRoot = "example",
            FilesAgentVersion = "example",
            OutboundAgentId = 1,
            GoogleCloudStorageAuthenticationMethod = "json",
            GoogleCloudStorageBucket = "my-bucket",
            GoogleCloudStorageOauthScope = "https://www.googleapis.com/auth/devstorage.read_only",
            GoogleCloudStorageProjectId = "my-project",
            GoogleCloudStorageS3CompatibleAccessKey = "example",
            Hostname = "remote-server.com",
            LinodeAccessKey = "example",
            LinodeBucket = "my-bucket",
            LinodeRegion = "us-east-1",
            MaxConnections = 1,
            Name = "My Remote server",
            OneDriveAccountType = "personal",
            PinToSiteRegion = true,
            Port = 1,
            UploadStagingPath = "/tmp/uploads",
            RemoteServerCredentialId = 1,
            S3AssumeRoleArn = "example",
            S3AssumeRoleDurationSeconds = 1,
            S3Bucket = "my-bucket",
            S3CompatibleAccessKey = "example",
            S3CompatibleBucket = "my-bucket",
            S3CompatibleEndpoint = "mys3platform.com",
            S3CompatibleRegion = "us-east-1",
            S3CompatibleVirtualHostedStyle = true,
            S3Region = "us-east-1",
            ServerCertificate = "require_match",
            ServerHostKey = "[public key]",
            ServerType = "s3",
            SharepointClientId = "00000000-0000-0000-0000-000000000000",
            SharepointSiteUrl = "https://example.sharepoint.com/sites/accounting",
            SharepointTenantId = "00000000-0000-0000-0000-000000000000",
            Ssl = "if_available",
            Username = "user",
            WasabiAccessKey = "example",
            WasabiBucket = "my-bucket",
            WasabiRegion = "us-west-1",
            WorkspaceId = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.RemoteServer;
    import com.pulumi.filescom.RemoteServerArgs;
    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) {
            var exampleRemoteServer = new RemoteServer("exampleRemoteServer", RemoteServerArgs.builder()
                .userId(1)
                .resetAuthentication(false)
                .allowRelativePaths(true)
                .awsAccessKey("example")
                .azureBlobStorageAccount("storage-account-name")
                .azureBlobStorageContainer("container-name")
                .azureBlobStorageDnsSuffix("usgovcloudapi.net")
                .azureBlobStorageHierarchicalNamespace(true)
                .azureFilesStorageAccount("storage-account-name")
                .azureFilesStorageDnsSuffix("file.core.windows.net")
                .azureFilesStorageShareName("share-name")
                .backblazeB2Bucket("my-bucket")
                .backblazeB2S3Endpoint("s3.us-west-001.backblazeb2.com")
                .bufferUploads("example")
                .cloudflareAccessKey("example")
                .cloudflareBucket("my-bucket")
                .cloudflareEndpoint("https://<ACCOUNT_ID>.r2.cloudflarestorage.com")
                .description("More information or notes about my server")
                .dropboxTeams(true)
                .enableDedicatedIps(true)
                .filebaseAccessKey("example")
                .filebaseBucket("my-bucket")
                .filesAgentPermissionSet("read_write")
                .filesAgentRoot("example")
                .filesAgentVersion("example")
                .outboundAgentId(1)
                .googleCloudStorageAuthenticationMethod("json")
                .googleCloudStorageBucket("my-bucket")
                .googleCloudStorageOauthScope("https://www.googleapis.com/auth/devstorage.read_only")
                .googleCloudStorageProjectId("my-project")
                .googleCloudStorageS3CompatibleAccessKey("example")
                .hostname("remote-server.com")
                .linodeAccessKey("example")
                .linodeBucket("my-bucket")
                .linodeRegion("us-east-1")
                .maxConnections(1)
                .name("My Remote server")
                .oneDriveAccountType("personal")
                .pinToSiteRegion(true)
                .port(1)
                .uploadStagingPath("/tmp/uploads")
                .remoteServerCredentialId(1)
                .s3AssumeRoleArn("example")
                .s3AssumeRoleDurationSeconds(1)
                .s3Bucket("my-bucket")
                .s3CompatibleAccessKey("example")
                .s3CompatibleBucket("my-bucket")
                .s3CompatibleEndpoint("mys3platform.com")
                .s3CompatibleRegion("us-east-1")
                .s3CompatibleVirtualHostedStyle(true)
                .s3Region("us-east-1")
                .serverCertificate("require_match")
                .serverHostKey("[public key]")
                .serverType("s3")
                .sharepointClientId("00000000-0000-0000-0000-000000000000")
                .sharepointSiteUrl("https://example.sharepoint.com/sites/accounting")
                .sharepointTenantId("00000000-0000-0000-0000-000000000000")
                .ssl("if_available")
                .username("user")
                .wasabiAccessKey("example")
                .wasabiBucket("my-bucket")
                .wasabiRegion("us-west-1")
                .workspaceId(0)
                .build());
    
        }
    }
    
    resources:
      exampleRemoteServer:
        type: filescom:RemoteServer
        name: example_remote_server
        properties:
          userId: 1
          resetAuthentication: false
          allowRelativePaths: true
          awsAccessKey: example
          azureBlobStorageAccount: storage-account-name
          azureBlobStorageContainer: container-name
          azureBlobStorageDnsSuffix: usgovcloudapi.net
          azureBlobStorageHierarchicalNamespace: true
          azureFilesStorageAccount: storage-account-name
          azureFilesStorageDnsSuffix: file.core.windows.net
          azureFilesStorageShareName: share-name
          backblazeB2Bucket: my-bucket
          backblazeB2S3Endpoint: s3.us-west-001.backblazeb2.com
          bufferUploads: example
          cloudflareAccessKey: example
          cloudflareBucket: my-bucket
          cloudflareEndpoint: https://<ACCOUNT_ID>.r2.cloudflarestorage.com
          description: More information or notes about my server
          dropboxTeams: true
          enableDedicatedIps: true
          filebaseAccessKey: example
          filebaseBucket: my-bucket
          filesAgentPermissionSet: read_write
          filesAgentRoot: example
          filesAgentVersion: example
          outboundAgentId: 1
          googleCloudStorageAuthenticationMethod: json
          googleCloudStorageBucket: my-bucket
          googleCloudStorageOauthScope: https://www.googleapis.com/auth/devstorage.read_only
          googleCloudStorageProjectId: my-project
          googleCloudStorageS3CompatibleAccessKey: example
          hostname: remote-server.com
          linodeAccessKey: example
          linodeBucket: my-bucket
          linodeRegion: us-east-1
          maxConnections: 1
          name: My Remote server
          oneDriveAccountType: personal
          pinToSiteRegion: true
          port: 1
          uploadStagingPath: /tmp/uploads
          remoteServerCredentialId: 1
          s3AssumeRoleArn: example
          s3AssumeRoleDurationSeconds: 1
          s3Bucket: my-bucket
          s3CompatibleAccessKey: example
          s3CompatibleBucket: my-bucket
          s3CompatibleEndpoint: mys3platform.com
          s3CompatibleRegion: us-east-1
          s3CompatibleVirtualHostedStyle: true
          s3Region: us-east-1
          serverCertificate: require_match
          serverHostKey: '[public key]'
          serverType: s3
          sharepointClientId: 00000000-0000-0000-0000-000000000000
          sharepointSiteUrl: https://example.sharepoint.com/sites/accounting
          sharepointTenantId: 00000000-0000-0000-0000-000000000000
          ssl: if_available
          username: user
          wasabiAccessKey: example
          wasabiBucket: my-bucket
          wasabiRegion: us-west-1
          workspaceId: 0
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_remoteserver" "example_remote_server" {
      user_id                                       = 1
      reset_authentication                          = false
      allow_relative_paths                          = true
      aws_access_key                                = "example"
      azure_blob_storage_account                    = "storage-account-name"
      azure_blob_storage_container                  = "container-name"
      azure_blob_storage_dns_suffix                 = "usgovcloudapi.net"
      azure_blob_storage_hierarchical_namespace     = true
      azure_files_storage_account                   = "storage-account-name"
      azure_files_storage_dns_suffix                = "file.core.windows.net"
      azure_files_storage_share_name                = "share-name"
      backblaze_b2_bucket                           = "my-bucket"
      backblaze_b2_s3_endpoint                      = "s3.us-west-001.backblazeb2.com"
      buffer_uploads                                = "example"
      cloudflare_access_key                         = "example"
      cloudflare_bucket                             = "my-bucket"
      cloudflare_endpoint                           = "https://<ACCOUNT_ID>.r2.cloudflarestorage.com"
      description                                   = "More information or notes about my server"
      dropbox_teams                                 = true
      enable_dedicated_ips                          = true
      filebase_access_key                           = "example"
      filebase_bucket                               = "my-bucket"
      files_agent_permission_set                    = "read_write"
      files_agent_root                              = "example"
      files_agent_version                           = "example"
      outbound_agent_id                             = 1
      google_cloud_storage_authentication_method    = "json"
      google_cloud_storage_bucket                   = "my-bucket"
      google_cloud_storage_oauth_scope              = "https://www.googleapis.com/auth/devstorage.read_only"
      google_cloud_storage_project_id               = "my-project"
      google_cloud_storage_s3_compatible_access_key = "example"
      hostname                                      = "remote-server.com"
      linode_access_key                             = "example"
      linode_bucket                                 = "my-bucket"
      linode_region                                 = "us-east-1"
      max_connections                               = 1
      name                                          = "My Remote server"
      one_drive_account_type                        = "personal"
      pin_to_site_region                            = true
      port                                          = 1
      upload_staging_path                           = "/tmp/uploads"
      remote_server_credential_id                   = 1
      s3_assume_role_arn                            = "example"
      s3_assume_role_duration_seconds               = 1
      s3_bucket                                     = "my-bucket"
      s3_compatible_access_key                      = "example"
      s3_compatible_bucket                          = "my-bucket"
      s3_compatible_endpoint                        = "mys3platform.com"
      s3_compatible_region                          = "us-east-1"
      s3_compatible_virtual_hosted_style            = true
      s3_region                                     = "us-east-1"
      server_certificate                            = "require_match"
      server_host_key                               = "[public key]"
      server_type                                   = "s3"
      sharepoint_client_id                          = "00000000-0000-0000-0000-000000000000"
      sharepoint_site_url                           = "https://example.sharepoint.com/sites/accounting"
      sharepoint_tenant_id                          = "00000000-0000-0000-0000-000000000000"
      ssl                                           = "if_available"
      username                                      = "user"
      wasabi_access_key                             = "example"
      wasabi_bucket                                 = "my-bucket"
      wasabi_region                                 = "us-west-1"
      workspace_id                                  = 0
    }
    

    Create RemoteServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RemoteServer(name: string, args?: RemoteServerArgs, opts?: CustomResourceOptions);
    @overload
    def RemoteServer(resource_name: str,
                     args: Optional[RemoteServerArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def RemoteServer(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     allow_relative_paths: Optional[bool] = None,
                     aws_access_key: Optional[str] = None,
                     aws_secret_key: Optional[str] = None,
                     azure_blob_storage_access_key: Optional[str] = None,
                     azure_blob_storage_account: Optional[str] = None,
                     azure_blob_storage_container: Optional[str] = None,
                     azure_blob_storage_dns_suffix: Optional[str] = None,
                     azure_blob_storage_hierarchical_namespace: Optional[bool] = None,
                     azure_blob_storage_sas_token: Optional[str] = None,
                     azure_files_storage_access_key: Optional[str] = None,
                     azure_files_storage_account: Optional[str] = None,
                     azure_files_storage_dns_suffix: Optional[str] = None,
                     azure_files_storage_sas_token: Optional[str] = None,
                     azure_files_storage_share_name: Optional[str] = None,
                     backblaze_b2_application_key: Optional[str] = None,
                     backblaze_b2_bucket: Optional[str] = None,
                     backblaze_b2_key_id: Optional[str] = None,
                     backblaze_b2_s3_endpoint: Optional[str] = None,
                     buffer_uploads: Optional[str] = None,
                     cloudflare_access_key: Optional[str] = None,
                     cloudflare_bucket: Optional[str] = None,
                     cloudflare_endpoint: Optional[str] = None,
                     cloudflare_secret_key: Optional[str] = None,
                     description: Optional[str] = None,
                     dropbox_teams: Optional[bool] = None,
                     enable_dedicated_ips: Optional[bool] = None,
                     filebase_access_key: Optional[str] = None,
                     filebase_bucket: Optional[str] = None,
                     filebase_secret_key: Optional[str] = None,
                     files_agent_permission_set: Optional[str] = None,
                     files_agent_root: Optional[str] = None,
                     files_agent_version: Optional[str] = None,
                     files_api_key: Optional[str] = None,
                     google_cloud_storage_authentication_method: Optional[str] = None,
                     google_cloud_storage_bucket: Optional[str] = None,
                     google_cloud_storage_credentials_json: Optional[str] = None,
                     google_cloud_storage_oauth_scope: Optional[str] = None,
                     google_cloud_storage_project_id: Optional[str] = None,
                     google_cloud_storage_s3_compatible_access_key: Optional[str] = None,
                     google_cloud_storage_s3_compatible_secret_key: Optional[str] = None,
                     hostname: Optional[str] = None,
                     linode_access_key: Optional[str] = None,
                     linode_bucket: Optional[str] = None,
                     linode_region: Optional[str] = None,
                     linode_secret_key: Optional[str] = None,
                     max_connections: Optional[int] = None,
                     name: Optional[str] = None,
                     one_drive_account_type: Optional[str] = None,
                     outbound_agent_id: Optional[int] = None,
                     password: Optional[str] = None,
                     pin_to_site_region: Optional[bool] = None,
                     port: Optional[int] = None,
                     private_key: Optional[str] = None,
                     private_key_passphrase: Optional[str] = None,
                     remote_server_credential_id: Optional[int] = None,
                     reset_authentication: Optional[bool] = None,
                     s3_assume_role_arn: Optional[str] = None,
                     s3_assume_role_duration_seconds: Optional[int] = None,
                     s3_bucket: Optional[str] = None,
                     s3_compatible_access_key: Optional[str] = None,
                     s3_compatible_bucket: Optional[str] = None,
                     s3_compatible_endpoint: Optional[str] = None,
                     s3_compatible_region: Optional[str] = None,
                     s3_compatible_secret_key: Optional[str] = None,
                     s3_compatible_virtual_hosted_style: Optional[bool] = None,
                     s3_region: Optional[str] = None,
                     server_certificate: Optional[str] = None,
                     server_host_key: Optional[str] = None,
                     server_type: Optional[str] = None,
                     sharepoint_client_certificate: Optional[str] = None,
                     sharepoint_client_id: Optional[str] = None,
                     sharepoint_client_secret: Optional[str] = None,
                     sharepoint_site_url: Optional[str] = None,
                     sharepoint_tenant_id: Optional[str] = None,
                     ssl: Optional[str] = None,
                     ssl_certificate: Optional[str] = None,
                     upload_staging_path: Optional[str] = None,
                     user_id: Optional[int] = None,
                     username: Optional[str] = None,
                     wasabi_access_key: Optional[str] = None,
                     wasabi_bucket: Optional[str] = None,
                     wasabi_region: Optional[str] = None,
                     wasabi_secret_key: Optional[str] = None,
                     workspace_id: Optional[int] = None)
    func NewRemoteServer(ctx *Context, name string, args *RemoteServerArgs, opts ...ResourceOption) (*RemoteServer, error)
    public RemoteServer(string name, RemoteServerArgs? args = null, CustomResourceOptions? opts = null)
    public RemoteServer(String name, RemoteServerArgs args)
    public RemoteServer(String name, RemoteServerArgs args, CustomResourceOptions options)
    
    type: filescom:RemoteServer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_remote_server" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RemoteServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RemoteServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RemoteServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RemoteServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RemoteServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var remoteServerResource = new Filescom.RemoteServer("remoteServerResource", new()
    {
        AllowRelativePaths = false,
        AwsAccessKey = "string",
        AwsSecretKey = "string",
        AzureBlobStorageAccessKey = "string",
        AzureBlobStorageAccount = "string",
        AzureBlobStorageContainer = "string",
        AzureBlobStorageDnsSuffix = "string",
        AzureBlobStorageHierarchicalNamespace = false,
        AzureBlobStorageSasToken = "string",
        AzureFilesStorageAccessKey = "string",
        AzureFilesStorageAccount = "string",
        AzureFilesStorageDnsSuffix = "string",
        AzureFilesStorageSasToken = "string",
        AzureFilesStorageShareName = "string",
        BackblazeB2ApplicationKey = "string",
        BackblazeB2Bucket = "string",
        BackblazeB2KeyId = "string",
        BackblazeB2S3Endpoint = "string",
        BufferUploads = "string",
        CloudflareAccessKey = "string",
        CloudflareBucket = "string",
        CloudflareEndpoint = "string",
        CloudflareSecretKey = "string",
        Description = "string",
        DropboxTeams = false,
        EnableDedicatedIps = false,
        FilebaseAccessKey = "string",
        FilebaseBucket = "string",
        FilebaseSecretKey = "string",
        FilesAgentPermissionSet = "string",
        FilesAgentRoot = "string",
        FilesAgentVersion = "string",
        FilesApiKey = "string",
        GoogleCloudStorageAuthenticationMethod = "string",
        GoogleCloudStorageBucket = "string",
        GoogleCloudStorageCredentialsJson = "string",
        GoogleCloudStorageOauthScope = "string",
        GoogleCloudStorageProjectId = "string",
        GoogleCloudStorageS3CompatibleAccessKey = "string",
        GoogleCloudStorageS3CompatibleSecretKey = "string",
        Hostname = "string",
        LinodeAccessKey = "string",
        LinodeBucket = "string",
        LinodeRegion = "string",
        LinodeSecretKey = "string",
        MaxConnections = 0,
        Name = "string",
        OneDriveAccountType = "string",
        OutboundAgentId = 0,
        Password = "string",
        PinToSiteRegion = false,
        Port = 0,
        PrivateKey = "string",
        PrivateKeyPassphrase = "string",
        RemoteServerCredentialId = 0,
        ResetAuthentication = false,
        S3AssumeRoleArn = "string",
        S3AssumeRoleDurationSeconds = 0,
        S3Bucket = "string",
        S3CompatibleAccessKey = "string",
        S3CompatibleBucket = "string",
        S3CompatibleEndpoint = "string",
        S3CompatibleRegion = "string",
        S3CompatibleSecretKey = "string",
        S3CompatibleVirtualHostedStyle = false,
        S3Region = "string",
        ServerCertificate = "string",
        ServerHostKey = "string",
        ServerType = "string",
        SharepointClientCertificate = "string",
        SharepointClientId = "string",
        SharepointClientSecret = "string",
        SharepointSiteUrl = "string",
        SharepointTenantId = "string",
        Ssl = "string",
        SslCertificate = "string",
        UploadStagingPath = "string",
        UserId = 0,
        Username = "string",
        WasabiAccessKey = "string",
        WasabiBucket = "string",
        WasabiRegion = "string",
        WasabiSecretKey = "string",
        WorkspaceId = 0,
    });
    
    example, err := filescom.NewRemoteServer(ctx, "remoteServerResource", &filescom.RemoteServerArgs{
    	AllowRelativePaths:                      pulumi.Bool(false),
    	AwsAccessKey:                            pulumi.String("string"),
    	AwsSecretKey:                            pulumi.String("string"),
    	AzureBlobStorageAccessKey:               pulumi.String("string"),
    	AzureBlobStorageAccount:                 pulumi.String("string"),
    	AzureBlobStorageContainer:               pulumi.String("string"),
    	AzureBlobStorageDnsSuffix:               pulumi.String("string"),
    	AzureBlobStorageHierarchicalNamespace:   pulumi.Bool(false),
    	AzureBlobStorageSasToken:                pulumi.String("string"),
    	AzureFilesStorageAccessKey:              pulumi.String("string"),
    	AzureFilesStorageAccount:                pulumi.String("string"),
    	AzureFilesStorageDnsSuffix:              pulumi.String("string"),
    	AzureFilesStorageSasToken:               pulumi.String("string"),
    	AzureFilesStorageShareName:              pulumi.String("string"),
    	BackblazeB2ApplicationKey:               pulumi.String("string"),
    	BackblazeB2Bucket:                       pulumi.String("string"),
    	BackblazeB2KeyId:                        pulumi.String("string"),
    	BackblazeB2S3Endpoint:                   pulumi.String("string"),
    	BufferUploads:                           pulumi.String("string"),
    	CloudflareAccessKey:                     pulumi.String("string"),
    	CloudflareBucket:                        pulumi.String("string"),
    	CloudflareEndpoint:                      pulumi.String("string"),
    	CloudflareSecretKey:                     pulumi.String("string"),
    	Description:                             pulumi.String("string"),
    	DropboxTeams:                            pulumi.Bool(false),
    	EnableDedicatedIps:                      pulumi.Bool(false),
    	FilebaseAccessKey:                       pulumi.String("string"),
    	FilebaseBucket:                          pulumi.String("string"),
    	FilebaseSecretKey:                       pulumi.String("string"),
    	FilesAgentPermissionSet:                 pulumi.String("string"),
    	FilesAgentRoot:                          pulumi.String("string"),
    	FilesAgentVersion:                       pulumi.String("string"),
    	FilesApiKey:                             pulumi.String("string"),
    	GoogleCloudStorageAuthenticationMethod:  pulumi.String("string"),
    	GoogleCloudStorageBucket:                pulumi.String("string"),
    	GoogleCloudStorageCredentialsJson:       pulumi.String("string"),
    	GoogleCloudStorageOauthScope:            pulumi.String("string"),
    	GoogleCloudStorageProjectId:             pulumi.String("string"),
    	GoogleCloudStorageS3CompatibleAccessKey: pulumi.String("string"),
    	GoogleCloudStorageS3CompatibleSecretKey: pulumi.String("string"),
    	Hostname:                                pulumi.String("string"),
    	LinodeAccessKey:                         pulumi.String("string"),
    	LinodeBucket:                            pulumi.String("string"),
    	LinodeRegion:                            pulumi.String("string"),
    	LinodeSecretKey:                         pulumi.String("string"),
    	MaxConnections:                          pulumi.Int(0),
    	Name:                                    pulumi.String("string"),
    	OneDriveAccountType:                     pulumi.String("string"),
    	OutboundAgentId:                         pulumi.Int(0),
    	Password:                                pulumi.String("string"),
    	PinToSiteRegion:                         pulumi.Bool(false),
    	Port:                                    pulumi.Int(0),
    	PrivateKey:                              pulumi.String("string"),
    	PrivateKeyPassphrase:                    pulumi.String("string"),
    	RemoteServerCredentialId:                pulumi.Int(0),
    	ResetAuthentication:                     pulumi.Bool(false),
    	S3AssumeRoleArn:                         pulumi.String("string"),
    	S3AssumeRoleDurationSeconds:             pulumi.Int(0),
    	S3Bucket:                                pulumi.String("string"),
    	S3CompatibleAccessKey:                   pulumi.String("string"),
    	S3CompatibleBucket:                      pulumi.String("string"),
    	S3CompatibleEndpoint:                    pulumi.String("string"),
    	S3CompatibleRegion:                      pulumi.String("string"),
    	S3CompatibleSecretKey:                   pulumi.String("string"),
    	S3CompatibleVirtualHostedStyle:          pulumi.Bool(false),
    	S3Region:                                pulumi.String("string"),
    	ServerCertificate:                       pulumi.String("string"),
    	ServerHostKey:                           pulumi.String("string"),
    	ServerType:                              pulumi.String("string"),
    	SharepointClientCertificate:             pulumi.String("string"),
    	SharepointClientId:                      pulumi.String("string"),
    	SharepointClientSecret:                  pulumi.String("string"),
    	SharepointSiteUrl:                       pulumi.String("string"),
    	SharepointTenantId:                      pulumi.String("string"),
    	Ssl:                                     pulumi.String("string"),
    	SslCertificate:                          pulumi.String("string"),
    	UploadStagingPath:                       pulumi.String("string"),
    	UserId:                                  pulumi.Int(0),
    	Username:                                pulumi.String("string"),
    	WasabiAccessKey:                         pulumi.String("string"),
    	WasabiBucket:                            pulumi.String("string"),
    	WasabiRegion:                            pulumi.String("string"),
    	WasabiSecretKey:                         pulumi.String("string"),
    	WorkspaceId:                             pulumi.Int(0),
    })
    
    resource "filescom_remote_server" "remoteServerResource" {
      lifecycle {
        create_before_destroy = true
      }
      allow_relative_paths                          = false
      aws_access_key                                = "string"
      aws_secret_key                                = "string"
      azure_blob_storage_access_key                 = "string"
      azure_blob_storage_account                    = "string"
      azure_blob_storage_container                  = "string"
      azure_blob_storage_dns_suffix                 = "string"
      azure_blob_storage_hierarchical_namespace     = false
      azure_blob_storage_sas_token                  = "string"
      azure_files_storage_access_key                = "string"
      azure_files_storage_account                   = "string"
      azure_files_storage_dns_suffix                = "string"
      azure_files_storage_sas_token                 = "string"
      azure_files_storage_share_name                = "string"
      backblaze_b2_application_key                  = "string"
      backblaze_b2_bucket                           = "string"
      backblaze_b2_key_id                           = "string"
      backblaze_b2_s3_endpoint                      = "string"
      buffer_uploads                                = "string"
      cloudflare_access_key                         = "string"
      cloudflare_bucket                             = "string"
      cloudflare_endpoint                           = "string"
      cloudflare_secret_key                         = "string"
      description                                   = "string"
      dropbox_teams                                 = false
      enable_dedicated_ips                          = false
      filebase_access_key                           = "string"
      filebase_bucket                               = "string"
      filebase_secret_key                           = "string"
      files_agent_permission_set                    = "string"
      files_agent_root                              = "string"
      files_agent_version                           = "string"
      files_api_key                                 = "string"
      google_cloud_storage_authentication_method    = "string"
      google_cloud_storage_bucket                   = "string"
      google_cloud_storage_credentials_json         = "string"
      google_cloud_storage_oauth_scope              = "string"
      google_cloud_storage_project_id               = "string"
      google_cloud_storage_s3_compatible_access_key = "string"
      google_cloud_storage_s3_compatible_secret_key = "string"
      hostname                                      = "string"
      linode_access_key                             = "string"
      linode_bucket                                 = "string"
      linode_region                                 = "string"
      linode_secret_key                             = "string"
      max_connections                               = 0
      name                                          = "string"
      one_drive_account_type                        = "string"
      outbound_agent_id                             = 0
      password                                      = "string"
      pin_to_site_region                            = false
      port                                          = 0
      private_key                                   = "string"
      private_key_passphrase                        = "string"
      remote_server_credential_id                   = 0
      reset_authentication                          = false
      s3_assume_role_arn                            = "string"
      s3_assume_role_duration_seconds               = 0
      s3_bucket                                     = "string"
      s3_compatible_access_key                      = "string"
      s3_compatible_bucket                          = "string"
      s3_compatible_endpoint                        = "string"
      s3_compatible_region                          = "string"
      s3_compatible_secret_key                      = "string"
      s3_compatible_virtual_hosted_style            = false
      s3_region                                     = "string"
      server_certificate                            = "string"
      server_host_key                               = "string"
      server_type                                   = "string"
      sharepoint_client_certificate                 = "string"
      sharepoint_client_id                          = "string"
      sharepoint_client_secret                      = "string"
      sharepoint_site_url                           = "string"
      sharepoint_tenant_id                          = "string"
      ssl                                           = "string"
      ssl_certificate                               = "string"
      upload_staging_path                           = "string"
      user_id                                       = 0
      username                                      = "string"
      wasabi_access_key                             = "string"
      wasabi_bucket                                 = "string"
      wasabi_region                                 = "string"
      wasabi_secret_key                             = "string"
      workspace_id                                  = 0
    }
    
    var remoteServerResource = new RemoteServer("remoteServerResource", RemoteServerArgs.builder()
        .allowRelativePaths(false)
        .awsAccessKey("string")
        .awsSecretKey("string")
        .azureBlobStorageAccessKey("string")
        .azureBlobStorageAccount("string")
        .azureBlobStorageContainer("string")
        .azureBlobStorageDnsSuffix("string")
        .azureBlobStorageHierarchicalNamespace(false)
        .azureBlobStorageSasToken("string")
        .azureFilesStorageAccessKey("string")
        .azureFilesStorageAccount("string")
        .azureFilesStorageDnsSuffix("string")
        .azureFilesStorageSasToken("string")
        .azureFilesStorageShareName("string")
        .backblazeB2ApplicationKey("string")
        .backblazeB2Bucket("string")
        .backblazeB2KeyId("string")
        .backblazeB2S3Endpoint("string")
        .bufferUploads("string")
        .cloudflareAccessKey("string")
        .cloudflareBucket("string")
        .cloudflareEndpoint("string")
        .cloudflareSecretKey("string")
        .description("string")
        .dropboxTeams(false)
        .enableDedicatedIps(false)
        .filebaseAccessKey("string")
        .filebaseBucket("string")
        .filebaseSecretKey("string")
        .filesAgentPermissionSet("string")
        .filesAgentRoot("string")
        .filesAgentVersion("string")
        .filesApiKey("string")
        .googleCloudStorageAuthenticationMethod("string")
        .googleCloudStorageBucket("string")
        .googleCloudStorageCredentialsJson("string")
        .googleCloudStorageOauthScope("string")
        .googleCloudStorageProjectId("string")
        .googleCloudStorageS3CompatibleAccessKey("string")
        .googleCloudStorageS3CompatibleSecretKey("string")
        .hostname("string")
        .linodeAccessKey("string")
        .linodeBucket("string")
        .linodeRegion("string")
        .linodeSecretKey("string")
        .maxConnections(0)
        .name("string")
        .oneDriveAccountType("string")
        .outboundAgentId(0)
        .password("string")
        .pinToSiteRegion(false)
        .port(0)
        .privateKey("string")
        .privateKeyPassphrase("string")
        .remoteServerCredentialId(0)
        .resetAuthentication(false)
        .s3AssumeRoleArn("string")
        .s3AssumeRoleDurationSeconds(0)
        .s3Bucket("string")
        .s3CompatibleAccessKey("string")
        .s3CompatibleBucket("string")
        .s3CompatibleEndpoint("string")
        .s3CompatibleRegion("string")
        .s3CompatibleSecretKey("string")
        .s3CompatibleVirtualHostedStyle(false)
        .s3Region("string")
        .serverCertificate("string")
        .serverHostKey("string")
        .serverType("string")
        .sharepointClientCertificate("string")
        .sharepointClientId("string")
        .sharepointClientSecret("string")
        .sharepointSiteUrl("string")
        .sharepointTenantId("string")
        .ssl("string")
        .sslCertificate("string")
        .uploadStagingPath("string")
        .userId(0)
        .username("string")
        .wasabiAccessKey("string")
        .wasabiBucket("string")
        .wasabiRegion("string")
        .wasabiSecretKey("string")
        .workspaceId(0)
        .build());
    
    remote_server_resource = filescom.RemoteServer("remoteServerResource",
        allow_relative_paths=False,
        aws_access_key="string",
        aws_secret_key="string",
        azure_blob_storage_access_key="string",
        azure_blob_storage_account="string",
        azure_blob_storage_container="string",
        azure_blob_storage_dns_suffix="string",
        azure_blob_storage_hierarchical_namespace=False,
        azure_blob_storage_sas_token="string",
        azure_files_storage_access_key="string",
        azure_files_storage_account="string",
        azure_files_storage_dns_suffix="string",
        azure_files_storage_sas_token="string",
        azure_files_storage_share_name="string",
        backblaze_b2_application_key="string",
        backblaze_b2_bucket="string",
        backblaze_b2_key_id="string",
        backblaze_b2_s3_endpoint="string",
        buffer_uploads="string",
        cloudflare_access_key="string",
        cloudflare_bucket="string",
        cloudflare_endpoint="string",
        cloudflare_secret_key="string",
        description="string",
        dropbox_teams=False,
        enable_dedicated_ips=False,
        filebase_access_key="string",
        filebase_bucket="string",
        filebase_secret_key="string",
        files_agent_permission_set="string",
        files_agent_root="string",
        files_agent_version="string",
        files_api_key="string",
        google_cloud_storage_authentication_method="string",
        google_cloud_storage_bucket="string",
        google_cloud_storage_credentials_json="string",
        google_cloud_storage_oauth_scope="string",
        google_cloud_storage_project_id="string",
        google_cloud_storage_s3_compatible_access_key="string",
        google_cloud_storage_s3_compatible_secret_key="string",
        hostname="string",
        linode_access_key="string",
        linode_bucket="string",
        linode_region="string",
        linode_secret_key="string",
        max_connections=0,
        name="string",
        one_drive_account_type="string",
        outbound_agent_id=0,
        password="string",
        pin_to_site_region=False,
        port=0,
        private_key="string",
        private_key_passphrase="string",
        remote_server_credential_id=0,
        reset_authentication=False,
        s3_assume_role_arn="string",
        s3_assume_role_duration_seconds=0,
        s3_bucket="string",
        s3_compatible_access_key="string",
        s3_compatible_bucket="string",
        s3_compatible_endpoint="string",
        s3_compatible_region="string",
        s3_compatible_secret_key="string",
        s3_compatible_virtual_hosted_style=False,
        s3_region="string",
        server_certificate="string",
        server_host_key="string",
        server_type="string",
        sharepoint_client_certificate="string",
        sharepoint_client_id="string",
        sharepoint_client_secret="string",
        sharepoint_site_url="string",
        sharepoint_tenant_id="string",
        ssl="string",
        ssl_certificate="string",
        upload_staging_path="string",
        user_id=0,
        username="string",
        wasabi_access_key="string",
        wasabi_bucket="string",
        wasabi_region="string",
        wasabi_secret_key="string",
        workspace_id=0)
    
    const remoteServerResource = new filescom.RemoteServer("remoteServerResource", {
        allowRelativePaths: false,
        awsAccessKey: "string",
        awsSecretKey: "string",
        azureBlobStorageAccessKey: "string",
        azureBlobStorageAccount: "string",
        azureBlobStorageContainer: "string",
        azureBlobStorageDnsSuffix: "string",
        azureBlobStorageHierarchicalNamespace: false,
        azureBlobStorageSasToken: "string",
        azureFilesStorageAccessKey: "string",
        azureFilesStorageAccount: "string",
        azureFilesStorageDnsSuffix: "string",
        azureFilesStorageSasToken: "string",
        azureFilesStorageShareName: "string",
        backblazeB2ApplicationKey: "string",
        backblazeB2Bucket: "string",
        backblazeB2KeyId: "string",
        backblazeB2S3Endpoint: "string",
        bufferUploads: "string",
        cloudflareAccessKey: "string",
        cloudflareBucket: "string",
        cloudflareEndpoint: "string",
        cloudflareSecretKey: "string",
        description: "string",
        dropboxTeams: false,
        enableDedicatedIps: false,
        filebaseAccessKey: "string",
        filebaseBucket: "string",
        filebaseSecretKey: "string",
        filesAgentPermissionSet: "string",
        filesAgentRoot: "string",
        filesAgentVersion: "string",
        filesApiKey: "string",
        googleCloudStorageAuthenticationMethod: "string",
        googleCloudStorageBucket: "string",
        googleCloudStorageCredentialsJson: "string",
        googleCloudStorageOauthScope: "string",
        googleCloudStorageProjectId: "string",
        googleCloudStorageS3CompatibleAccessKey: "string",
        googleCloudStorageS3CompatibleSecretKey: "string",
        hostname: "string",
        linodeAccessKey: "string",
        linodeBucket: "string",
        linodeRegion: "string",
        linodeSecretKey: "string",
        maxConnections: 0,
        name: "string",
        oneDriveAccountType: "string",
        outboundAgentId: 0,
        password: "string",
        pinToSiteRegion: false,
        port: 0,
        privateKey: "string",
        privateKeyPassphrase: "string",
        remoteServerCredentialId: 0,
        resetAuthentication: false,
        s3AssumeRoleArn: "string",
        s3AssumeRoleDurationSeconds: 0,
        s3Bucket: "string",
        s3CompatibleAccessKey: "string",
        s3CompatibleBucket: "string",
        s3CompatibleEndpoint: "string",
        s3CompatibleRegion: "string",
        s3CompatibleSecretKey: "string",
        s3CompatibleVirtualHostedStyle: false,
        s3Region: "string",
        serverCertificate: "string",
        serverHostKey: "string",
        serverType: "string",
        sharepointClientCertificate: "string",
        sharepointClientId: "string",
        sharepointClientSecret: "string",
        sharepointSiteUrl: "string",
        sharepointTenantId: "string",
        ssl: "string",
        sslCertificate: "string",
        uploadStagingPath: "string",
        userId: 0,
        username: "string",
        wasabiAccessKey: "string",
        wasabiBucket: "string",
        wasabiRegion: "string",
        wasabiSecretKey: "string",
        workspaceId: 0,
    });
    
    type: filescom:RemoteServer
    properties:
        allowRelativePaths: false
        awsAccessKey: string
        awsSecretKey: string
        azureBlobStorageAccessKey: string
        azureBlobStorageAccount: string
        azureBlobStorageContainer: string
        azureBlobStorageDnsSuffix: string
        azureBlobStorageHierarchicalNamespace: false
        azureBlobStorageSasToken: string
        azureFilesStorageAccessKey: string
        azureFilesStorageAccount: string
        azureFilesStorageDnsSuffix: string
        azureFilesStorageSasToken: string
        azureFilesStorageShareName: string
        backblazeB2ApplicationKey: string
        backblazeB2Bucket: string
        backblazeB2KeyId: string
        backblazeB2S3Endpoint: string
        bufferUploads: string
        cloudflareAccessKey: string
        cloudflareBucket: string
        cloudflareEndpoint: string
        cloudflareSecretKey: string
        description: string
        dropboxTeams: false
        enableDedicatedIps: false
        filebaseAccessKey: string
        filebaseBucket: string
        filebaseSecretKey: string
        filesAgentPermissionSet: string
        filesAgentRoot: string
        filesAgentVersion: string
        filesApiKey: string
        googleCloudStorageAuthenticationMethod: string
        googleCloudStorageBucket: string
        googleCloudStorageCredentialsJson: string
        googleCloudStorageOauthScope: string
        googleCloudStorageProjectId: string
        googleCloudStorageS3CompatibleAccessKey: string
        googleCloudStorageS3CompatibleSecretKey: string
        hostname: string
        linodeAccessKey: string
        linodeBucket: string
        linodeRegion: string
        linodeSecretKey: string
        maxConnections: 0
        name: string
        oneDriveAccountType: string
        outboundAgentId: 0
        password: string
        pinToSiteRegion: false
        port: 0
        privateKey: string
        privateKeyPassphrase: string
        remoteServerCredentialId: 0
        resetAuthentication: false
        s3AssumeRoleArn: string
        s3AssumeRoleDurationSeconds: 0
        s3Bucket: string
        s3CompatibleAccessKey: string
        s3CompatibleBucket: string
        s3CompatibleEndpoint: string
        s3CompatibleRegion: string
        s3CompatibleSecretKey: string
        s3CompatibleVirtualHostedStyle: false
        s3Region: string
        serverCertificate: string
        serverHostKey: string
        serverType: string
        sharepointClientCertificate: string
        sharepointClientId: string
        sharepointClientSecret: string
        sharepointSiteUrl: string
        sharepointTenantId: string
        ssl: string
        sslCertificate: string
        uploadStagingPath: string
        userId: 0
        username: string
        wasabiAccessKey: string
        wasabiBucket: string
        wasabiRegion: string
        wasabiSecretKey: string
        workspaceId: 0
    

    RemoteServer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RemoteServer resource accepts the following input properties:

    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.
    AwsAccessKey string
    AWS Access Key.
    AwsSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    AzureBlobStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    AzureBlobStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    AzureFilesStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    AzureFilesStorageAccount string
    Azure Files: Storage Account name
    AzureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    AzureFilesStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    AzureFilesStorageShareName string
    Azure Files: Storage Share name
    BackblazeB2ApplicationKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    BackblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    BackblazeB2KeyId string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    CloudflareSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    Description string
    Internal description for your reference
    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
    FilebaseSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    FilesAgentPermissionSet string
    Local permissions for files agent. read_only, write_only, or read_write
    FilesAgentRoot string
    Agent local root path
    FilesAgentVersion string
    Files Agent version
    FilesApiKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    GoogleCloudStorageAuthenticationMethod string
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    GoogleCloudStorageBucket string
    Google Cloud Storage: Bucket Name
    GoogleCloudStorageCredentialsJson string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    GoogleCloudStorageOauthScope 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.
    GoogleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    GoogleCloudStorageS3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    Hostname string
    Hostname or IP address
    LinodeAccessKey string
    Linode: Access Key
    LinodeBucket string
    Linode: Bucket name
    LinodeRegion string
    Linode: region
    LinodeSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    Port int
    Port for remote server.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    PrivateKeyPassphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    RemoteServerCredentialId int
    ID of Remote Server Credential, if applicable.
    ResetAuthentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    S3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    S3AssumeRoleDurationSeconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    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
    S3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    SharepointClientCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointClientSecret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    SslCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WasabiBucket string
    Wasabi: Bucket name
    WasabiRegion string
    Wasabi: Region
    WasabiSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    AwsAccessKey string
    AWS Access Key.
    AwsSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    AzureBlobStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    AzureBlobStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    AzureFilesStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    AzureFilesStorageAccount string
    Azure Files: Storage Account name
    AzureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    AzureFilesStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    AzureFilesStorageShareName string
    Azure Files: Storage Share name
    BackblazeB2ApplicationKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    BackblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    BackblazeB2KeyId string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    CloudflareSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    Description string
    Internal description for your reference
    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
    FilebaseSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    FilesAgentPermissionSet string
    Local permissions for files agent. read_only, write_only, or read_write
    FilesAgentRoot string
    Agent local root path
    FilesAgentVersion string
    Files Agent version
    FilesApiKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    GoogleCloudStorageAuthenticationMethod string
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    GoogleCloudStorageBucket string
    Google Cloud Storage: Bucket Name
    GoogleCloudStorageCredentialsJson string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    GoogleCloudStorageOauthScope 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.
    GoogleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    GoogleCloudStorageS3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    Hostname string
    Hostname or IP address
    LinodeAccessKey string
    Linode: Access Key
    LinodeBucket string
    Linode: Bucket name
    LinodeRegion string
    Linode: region
    LinodeSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    Port int
    Port for remote server.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    PrivateKeyPassphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    RemoteServerCredentialId int
    ID of Remote Server Credential, if applicable.
    ResetAuthentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    S3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    S3AssumeRoleDurationSeconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    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
    S3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    SharepointClientCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointClientSecret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    SslCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WasabiBucket string
    Wasabi: Bucket name
    WasabiRegion string
    Wasabi: Region
    WasabiSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    aws_access_key string
    AWS Access Key.
    aws_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azure_blob_storage_access_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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_blob_storage_sas_token string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azure_files_storage_access_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azure_files_storage_account string
    Azure Files: Storage Account name
    azure_files_storage_dns_suffix string
    Azure Files: Custom DNS suffix
    azure_files_storage_sas_token string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azure_files_storage_share_name string
    Azure Files: Storage Share name
    backblaze_b2_application_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblaze_b2_bucket string
    Backblaze B2 Cloud Storage: Bucket name
    backblaze_b2_key_id string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflare_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    description string
    Internal description for your reference
    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
    filebase_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    files_agent_permission_set string
    Local permissions for files agent. read_only, write_only, or read_write
    files_agent_root string
    Agent local root path
    files_agent_version string
    Files Agent version
    files_api_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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_credentials_json string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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_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.
    google_cloud_storage_s3_compatible_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret 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
    linode_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    port number
    Port for remote server.
    private_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    private_key_passphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remote_server_credential_id number
    ID of Remote Server Credential, if applicable.
    reset_authentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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_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_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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_client_certificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepoint_client_id string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_client_secret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    ssl_certificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    user_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username string
    Remote server username.
    wasabi_access_key string
    Wasabi: Access Key.
    wasabi_bucket string
    Wasabi: Bucket name
    wasabi_region string
    Wasabi: Region
    wasabi_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    awsAccessKey String
    AWS Access Key.
    awsSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azureBlobStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    azureBlobStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azureFilesStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azureFilesStorageAccount String
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix String
    Azure Files: Custom DNS suffix
    azureFilesStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azureFilesStorageShareName String
    Azure Files: Storage Share name
    backblazeB2ApplicationKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblazeB2Bucket String
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2KeyId String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflareSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    description String
    Internal description for your reference
    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
    filebaseSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    filesAgentPermissionSet String
    Local permissions for files agent. read_only, write_only, or read_write
    filesAgentRoot String
    Agent local root path
    filesAgentVersion String
    Files Agent version
    filesApiKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    googleCloudStorageAuthenticationMethod String
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    googleCloudStorageBucket String
    Google Cloud Storage: Bucket Name
    googleCloudStorageCredentialsJson String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    googleCloudStorageOauthScope 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.
    googleCloudStorageProjectId String
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    googleCloudStorageS3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname String
    Hostname or IP address
    linodeAccessKey String
    Linode: Access Key
    linodeBucket String
    Linode: Bucket name
    linodeRegion String
    Linode: region
    linodeSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    port Integer
    Port for remote server.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    privateKeyPassphrase String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remoteServerCredentialId Integer
    ID of Remote Server Credential, if applicable.
    resetAuthentication Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    s3AssumeRoleArn String
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds Integer
    Session duration in seconds for AssumeRole authentication (900-43200).
    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
    s3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    sharepointClientCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointClientSecret String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    sslCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    userId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    wasabiBucket String
    Wasabi: Bucket name
    wasabiRegion String
    Wasabi: Region
    wasabiSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    awsAccessKey string
    AWS Access Key.
    awsSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azureBlobStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    azureBlobStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azureFilesStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azureFilesStorageAccount string
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    azureFilesStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azureFilesStorageShareName string
    Azure Files: Storage Share name
    backblazeB2ApplicationKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2KeyId string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflareSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    description string
    Internal description for your reference
    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
    filebaseSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    filesAgentPermissionSet string
    Local permissions for files agent. read_only, write_only, or read_write
    filesAgentRoot string
    Agent local root path
    filesAgentVersion string
    Files Agent version
    filesApiKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    googleCloudStorageAuthenticationMethod string
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    googleCloudStorageBucket string
    Google Cloud Storage: Bucket Name
    googleCloudStorageCredentialsJson string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    googleCloudStorageOauthScope 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.
    googleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    googleCloudStorageS3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname string
    Hostname or IP address
    linodeAccessKey string
    Linode: Access Key
    linodeBucket string
    Linode: Bucket name
    linodeRegion string
    Linode: region
    linodeSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    port number
    Port for remote server.
    privateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    privateKeyPassphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remoteServerCredentialId number
    ID of Remote Server Credential, if applicable.
    resetAuthentication boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    s3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds number
    Session duration in seconds for AssumeRole authentication (900-43200).
    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
    s3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    sharepointClientCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointClientSecret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    sslCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    userId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username string
    Remote server username.
    wasabiAccessKey string
    Wasabi: Access Key.
    wasabiBucket string
    Wasabi: Bucket name
    wasabiRegion string
    Wasabi: Region
    wasabiSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    aws_access_key str
    AWS Access Key.
    aws_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azure_blob_storage_access_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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_blob_storage_sas_token str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azure_files_storage_access_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azure_files_storage_account str
    Azure Files: Storage Account name
    azure_files_storage_dns_suffix str
    Azure Files: Custom DNS suffix
    azure_files_storage_sas_token str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azure_files_storage_share_name str
    Azure Files: Storage Share name
    backblaze_b2_application_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblaze_b2_bucket str
    Backblaze B2 Cloud Storage: Bucket name
    backblaze_b2_key_id str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflare_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    description str
    Internal description for your reference
    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
    filebase_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    files_agent_permission_set str
    Local permissions for files agent. read_only, write_only, or read_write
    files_agent_root str
    Agent local root path
    files_agent_version str
    Files Agent version
    files_api_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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_credentials_json str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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_oauth_scope str
    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 str
    Google Cloud Storage: Project ID
    google_cloud_storage_s3_compatible_access_key str
    Google Cloud Storage: S3-compatible Access Key.
    google_cloud_storage_s3_compatible_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname str
    Hostname or IP address
    linode_access_key str
    Linode: Access Key
    linode_bucket str
    Linode: Bucket name
    linode_region str
    Linode: region
    linode_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    port int
    Port for remote server.
    private_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    private_key_passphrase str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remote_server_credential_id int
    ID of Remote Server Credential, if applicable.
    reset_authentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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_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_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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_client_certificate str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepoint_client_id str
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_client_secret str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    ssl_certificate str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    user_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username str
    Remote server username.
    wasabi_access_key str
    Wasabi: Access Key.
    wasabi_bucket str
    Wasabi: Bucket name
    wasabi_region str
    Wasabi: Region
    wasabi_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    awsAccessKey String
    AWS Access Key.
    awsSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azureBlobStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    azureBlobStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azureFilesStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azureFilesStorageAccount String
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix String
    Azure Files: Custom DNS suffix
    azureFilesStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azureFilesStorageShareName String
    Azure Files: Storage Share name
    backblazeB2ApplicationKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblazeB2Bucket String
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2KeyId String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflareSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    description String
    Internal description for your reference
    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
    filebaseSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    filesAgentPermissionSet String
    Local permissions for files agent. read_only, write_only, or read_write
    filesAgentRoot String
    Agent local root path
    filesAgentVersion String
    Files Agent version
    filesApiKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    googleCloudStorageAuthenticationMethod String
    Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
    googleCloudStorageBucket String
    Google Cloud Storage: Bucket Name
    googleCloudStorageCredentialsJson String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    googleCloudStorageOauthScope 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.
    googleCloudStorageProjectId String
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    googleCloudStorageS3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname String
    Hostname or IP address
    linodeAccessKey String
    Linode: Access Key
    linodeBucket String
    Linode: Bucket name
    linodeRegion String
    Linode: region
    linodeSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    port Number
    Port for remote server.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    privateKeyPassphrase String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remoteServerCredentialId Number
    ID of Remote Server Credential, if applicable.
    resetAuthentication Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    s3AssumeRoleArn String
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds Number
    Session duration in seconds for AssumeRole authentication (900-43200).
    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
    s3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    sharepointClientCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointClientSecret String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    sslCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    userId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    wasabiBucket String
    Wasabi: Bucket name
    wasabiRegion String
    Wasabi: Region
    wasabiSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    workspaceId Number
    Workspace ID (0 for default workspace)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RemoteServer resource produces the following output properties:

    AuthAccountName string
    Describes the authorized account
    AuthStatus string
    Either inSetup or complete
    AuthenticationMethod string
    Type of authentication method to use
    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.
    FilesAgentApiToken string
    Files Agent API Token
    FilesAgentLatestVersion string
    Latest available Files Agent version
    FilesAgentSupportsPushUpdates bool
    Files Agent supports receiving push updates
    FilesAgentUpToDate bool
    If true, the Files Agent is up to date.
    FilesApiKeyPrefix string
    Files.com direct link: paired API key prefix.
    Id string
    The provider-assigned unique ID for this managed resource.
    PinnedRegion string
    If set, all communications with this remote server are made through the provided region.
    RemoteHomePath string
    Initial home folder on remote server
    S3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    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.
    SupportsVersioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    AuthAccountName string
    Describes the authorized account
    AuthStatus string
    Either inSetup or complete
    AuthenticationMethod string
    Type of authentication method to use
    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.
    FilesAgentApiToken string
    Files Agent API Token
    FilesAgentLatestVersion string
    Latest available Files Agent version
    FilesAgentSupportsPushUpdates bool
    Files Agent supports receiving push updates
    FilesAgentUpToDate bool
    If true, the Files Agent is up to date.
    FilesApiKeyPrefix string
    Files.com direct link: paired API key prefix.
    Id string
    The provider-assigned unique ID for this managed resource.
    PinnedRegion string
    If set, all communications with this remote server are made through the provided region.
    RemoteHomePath string
    Initial home folder on remote server
    S3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    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.
    SupportsVersioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    auth_account_name string
    Describes the authorized account
    auth_status string
    Either inSetup or complete
    authentication_method string
    Type of authentication method to use
    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.
    files_agent_api_token string
    Files Agent API Token
    files_agent_latest_version string
    Latest available Files Agent version
    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_api_key_prefix string
    Files.com direct link: paired API key prefix.
    id string
    The provider-assigned unique ID for this managed resource.
    pinned_region string
    If set, all communications with this remote server are made through the provided region.
    remote_home_path string
    Initial home folder on remote server
    s3_assume_role_external_id string
    External ID for AssumeRole authentication.
    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.
    supports_versioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    authAccountName String
    Describes the authorized account
    authStatus String
    Either inSetup or complete
    authenticationMethod String
    Type of authentication method to use
    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.
    filesAgentApiToken String
    Files Agent API Token
    filesAgentLatestVersion String
    Latest available Files Agent version
    filesAgentSupportsPushUpdates Boolean
    Files Agent supports receiving push updates
    filesAgentUpToDate Boolean
    If true, the Files Agent is up to date.
    filesApiKeyPrefix String
    Files.com direct link: paired API key prefix.
    id String
    The provider-assigned unique ID for this managed resource.
    pinnedRegion String
    If set, all communications with this remote server are made through the provided region.
    remoteHomePath String
    Initial home folder on remote server
    s3AssumeRoleExternalId String
    External ID for AssumeRole authentication.
    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.
    supportsVersioning Boolean
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    authAccountName string
    Describes the authorized account
    authStatus string
    Either inSetup or complete
    authenticationMethod string
    Type of authentication method to use
    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.
    filesAgentApiToken string
    Files Agent API Token
    filesAgentLatestVersion string
    Latest available Files Agent version
    filesAgentSupportsPushUpdates boolean
    Files Agent supports receiving push updates
    filesAgentUpToDate boolean
    If true, the Files Agent is up to date.
    filesApiKeyPrefix string
    Files.com direct link: paired API key prefix.
    id string
    The provider-assigned unique ID for this managed resource.
    pinnedRegion string
    If set, all communications with this remote server are made through the provided region.
    remoteHomePath string
    Initial home folder on remote server
    s3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    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.
    supportsVersioning boolean
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    auth_account_name str
    Describes the authorized account
    auth_status str
    Either inSetup or complete
    authentication_method str
    Type of authentication method to use
    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.
    files_agent_api_token str
    Files Agent API Token
    files_agent_latest_version str
    Latest available Files Agent version
    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_api_key_prefix str
    Files.com direct link: paired API key prefix.
    id str
    The provider-assigned unique ID for this managed resource.
    pinned_region str
    If set, all communications with this remote server are made through the provided region.
    remote_home_path str
    Initial home folder on remote server
    s3_assume_role_external_id str
    External ID for AssumeRole authentication.
    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.
    supports_versioning bool
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
    authAccountName String
    Describes the authorized account
    authStatus String
    Either inSetup or complete
    authenticationMethod String
    Type of authentication method to use
    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.
    filesAgentApiToken String
    Files Agent API Token
    filesAgentLatestVersion String
    Latest available Files Agent version
    filesAgentSupportsPushUpdates Boolean
    Files Agent supports receiving push updates
    filesAgentUpToDate Boolean
    If true, the Files Agent is up to date.
    filesApiKeyPrefix String
    Files.com direct link: paired API key prefix.
    id String
    The provider-assigned unique ID for this managed resource.
    pinnedRegion String
    If set, all communications with this remote server are made through the provided region.
    remoteHomePath String
    Initial home folder on remote server
    s3AssumeRoleExternalId String
    External ID for AssumeRole authentication.
    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.
    supportsVersioning Boolean
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.

    Look up Existing RemoteServer Resource

    Get an existing RemoteServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RemoteServerState, opts?: CustomResourceOptions): RemoteServer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_relative_paths: Optional[bool] = None,
            auth_account_name: Optional[str] = None,
            auth_status: Optional[str] = None,
            authentication_method: Optional[str] = None,
            aws_access_key: Optional[str] = None,
            aws_secret_key: Optional[str] = None,
            azure_blob_storage_access_key: Optional[str] = None,
            azure_blob_storage_account: Optional[str] = None,
            azure_blob_storage_container: Optional[str] = None,
            azure_blob_storage_dns_suffix: Optional[str] = None,
            azure_blob_storage_hierarchical_namespace: Optional[bool] = None,
            azure_blob_storage_sas_token: Optional[str] = None,
            azure_files_storage_access_key: Optional[str] = None,
            azure_files_storage_account: Optional[str] = None,
            azure_files_storage_dns_suffix: Optional[str] = None,
            azure_files_storage_sas_token: Optional[str] = None,
            azure_files_storage_share_name: Optional[str] = None,
            backblaze_b2_application_key: Optional[str] = None,
            backblaze_b2_bucket: Optional[str] = None,
            backblaze_b2_key_id: Optional[str] = None,
            backblaze_b2_s3_endpoint: Optional[str] = None,
            buffer_uploads: Optional[str] = None,
            cloudflare_access_key: Optional[str] = None,
            cloudflare_bucket: Optional[str] = None,
            cloudflare_endpoint: Optional[str] = None,
            cloudflare_secret_key: Optional[str] = None,
            description: Optional[str] = None,
            direct_transfer_available: Optional[bool] = None,
            disabled: Optional[bool] = None,
            dropbox_teams: Optional[bool] = None,
            enable_dedicated_ips: Optional[bool] = None,
            filebase_access_key: Optional[str] = None,
            filebase_bucket: Optional[str] = None,
            filebase_secret_key: Optional[str] = None,
            files_agent_api_token: Optional[str] = None,
            files_agent_latest_version: Optional[str] = None,
            files_agent_permission_set: Optional[str] = None,
            files_agent_root: Optional[str] = None,
            files_agent_supports_push_updates: Optional[bool] = None,
            files_agent_up_to_date: Optional[bool] = None,
            files_agent_version: Optional[str] = None,
            files_api_key: Optional[str] = None,
            files_api_key_prefix: Optional[str] = None,
            google_cloud_storage_authentication_method: Optional[str] = None,
            google_cloud_storage_bucket: Optional[str] = None,
            google_cloud_storage_credentials_json: Optional[str] = None,
            google_cloud_storage_oauth_scope: Optional[str] = None,
            google_cloud_storage_project_id: Optional[str] = None,
            google_cloud_storage_s3_compatible_access_key: Optional[str] = None,
            google_cloud_storage_s3_compatible_secret_key: Optional[str] = None,
            hostname: Optional[str] = None,
            linode_access_key: Optional[str] = None,
            linode_bucket: Optional[str] = None,
            linode_region: Optional[str] = None,
            linode_secret_key: Optional[str] = None,
            max_connections: Optional[int] = None,
            name: Optional[str] = None,
            one_drive_account_type: Optional[str] = None,
            outbound_agent_id: Optional[int] = None,
            password: Optional[str] = None,
            pin_to_site_region: Optional[bool] = None,
            pinned_region: Optional[str] = None,
            port: Optional[int] = None,
            private_key: Optional[str] = None,
            private_key_passphrase: Optional[str] = None,
            remote_home_path: Optional[str] = None,
            remote_server_credential_id: Optional[int] = None,
            reset_authentication: Optional[bool] = None,
            s3_assume_role_arn: Optional[str] = None,
            s3_assume_role_duration_seconds: Optional[int] = None,
            s3_assume_role_external_id: Optional[str] = None,
            s3_bucket: Optional[str] = None,
            s3_compatible_access_key: Optional[str] = None,
            s3_compatible_bucket: Optional[str] = None,
            s3_compatible_endpoint: Optional[str] = None,
            s3_compatible_region: Optional[str] = None,
            s3_compatible_secret_key: Optional[str] = None,
            s3_compatible_virtual_hosted_style: Optional[bool] = None,
            s3_region: Optional[str] = None,
            server_certificate: Optional[str] = None,
            server_host_key: Optional[str] = None,
            server_type: Optional[str] = None,
            sharepoint_app_authentication: Optional[bool] = None,
            sharepoint_app_credential_type: Optional[str] = None,
            sharepoint_client_certificate: Optional[str] = None,
            sharepoint_client_id: Optional[str] = None,
            sharepoint_client_secret: Optional[str] = None,
            sharepoint_site_url: Optional[str] = None,
            sharepoint_tenant_id: Optional[str] = None,
            ssl: Optional[str] = None,
            ssl_certificate: Optional[str] = None,
            supports_versioning: Optional[bool] = None,
            upload_staging_path: Optional[str] = None,
            user_id: Optional[int] = None,
            username: Optional[str] = None,
            wasabi_access_key: Optional[str] = None,
            wasabi_bucket: Optional[str] = None,
            wasabi_region: Optional[str] = None,
            wasabi_secret_key: Optional[str] = None,
            workspace_id: Optional[int] = None) -> RemoteServer
    func GetRemoteServer(ctx *Context, name string, id IDInput, state *RemoteServerState, opts ...ResourceOption) (*RemoteServer, error)
    public static RemoteServer Get(string name, Input<string> id, RemoteServerState? state, CustomResourceOptions? opts = null)
    public static RemoteServer get(String name, Output<String> id, RemoteServerState state, CustomResourceOptions options)
    resources:  _:    type: filescom:RemoteServer    get:      id: ${id}
    import {
      to = filescom_remote_server.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.
    AwsSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    AzureBlobStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    AzureBlobStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    AzureFilesStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    AzureFilesStorageAccount string
    Azure Files: Storage Account name
    AzureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    AzureFilesStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    AzureFilesStorageShareName string
    Azure Files: Storage Share name
    BackblazeB2ApplicationKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    BackblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    BackblazeB2KeyId string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    CloudflareSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    FilebaseSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    FilesAgentApiToken string
    Files Agent API Token
    FilesAgentLatestVersion string
    Latest available Files Agent version
    FilesAgentPermissionSet string
    Local permissions for files agent. read_only, write_only, 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
    FilesApiKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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
    GoogleCloudStorageCredentialsJson string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    GoogleCloudStorageOauthScope 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.
    GoogleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    GoogleCloudStorageS3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    Hostname string
    Hostname or IP address
    LinodeAccessKey string
    Linode: Access Key
    LinodeBucket string
    Linode: Bucket name
    LinodeRegion string
    Linode: region
    LinodeSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    PrivateKeyPassphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    RemoteHomePath string
    Initial home folder on remote server
    RemoteServerCredentialId int
    ID of Remote Server Credential, if applicable.
    ResetAuthentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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
    S3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    SharepointClientCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointClientSecret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    SslCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WasabiBucket string
    Wasabi: Bucket name
    WasabiRegion string
    Wasabi: Region
    WasabiSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    AwsSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    AzureBlobStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    AzureBlobStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    AzureFilesStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    AzureFilesStorageAccount string
    Azure Files: Storage Account name
    AzureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    AzureFilesStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    AzureFilesStorageShareName string
    Azure Files: Storage Share name
    BackblazeB2ApplicationKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    BackblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    BackblazeB2KeyId string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    CloudflareSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    FilebaseSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    FilesAgentApiToken string
    Files Agent API Token
    FilesAgentLatestVersion string
    Latest available Files Agent version
    FilesAgentPermissionSet string
    Local permissions for files agent. read_only, write_only, 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
    FilesApiKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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
    GoogleCloudStorageCredentialsJson string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    GoogleCloudStorageOauthScope 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.
    GoogleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    GoogleCloudStorageS3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    Hostname string
    Hostname or IP address
    LinodeAccessKey string
    Linode: Access Key
    LinodeBucket string
    Linode: Bucket name
    LinodeRegion string
    Linode: region
    LinodeSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    PrivateKeyPassphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    RemoteHomePath string
    Initial home folder on remote server
    RemoteServerCredentialId int
    ID of Remote Server Credential, if applicable.
    ResetAuthentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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
    S3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    SharepointClientCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointClientSecret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    SslCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WasabiBucket string
    Wasabi: Bucket name
    WasabiRegion string
    Wasabi: Region
    WasabiSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    aws_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azure_blob_storage_access_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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_blob_storage_sas_token string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azure_files_storage_access_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azure_files_storage_account string
    Azure Files: Storage Account name
    azure_files_storage_dns_suffix string
    Azure Files: Custom DNS suffix
    azure_files_storage_sas_token string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azure_files_storage_share_name string
    Azure Files: Storage Share name
    backblaze_b2_application_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblaze_b2_bucket string
    Backblaze B2 Cloud Storage: Bucket name
    backblaze_b2_key_id string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflare_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    filebase_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    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. read_only, write_only, 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 string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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_credentials_json string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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_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.
    google_cloud_storage_s3_compatible_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret 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
    linode_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    private_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    private_key_passphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remote_home_path string
    Initial home folder on remote server
    remote_server_credential_id number
    ID of Remote Server Credential, if applicable.
    reset_authentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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_certificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepoint_client_id string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_client_secret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    ssl_certificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    user_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username string
    Remote server username.
    wasabi_access_key string
    Wasabi: Access Key.
    wasabi_bucket string
    Wasabi: Bucket name
    wasabi_region string
    Wasabi: Region
    wasabi_secret_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    awsSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azureBlobStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    azureBlobStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azureFilesStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azureFilesStorageAccount String
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix String
    Azure Files: Custom DNS suffix
    azureFilesStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azureFilesStorageShareName String
    Azure Files: Storage Share name
    backblazeB2ApplicationKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblazeB2Bucket String
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2KeyId String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflareSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    filebaseSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    filesAgentApiToken String
    Files Agent API Token
    filesAgentLatestVersion String
    Latest available Files Agent version
    filesAgentPermissionSet String
    Local permissions for files agent. read_only, write_only, 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
    filesApiKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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
    googleCloudStorageCredentialsJson String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    googleCloudStorageOauthScope 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.
    googleCloudStorageProjectId String
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    googleCloudStorageS3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname String
    Hostname or IP address
    linodeAccessKey String
    Linode: Access Key
    linodeBucket String
    Linode: Bucket name
    linodeRegion String
    Linode: region
    linodeSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    privateKeyPassphrase String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remoteHomePath String
    Initial home folder on remote server
    remoteServerCredentialId Integer
    ID of Remote Server Credential, if applicable.
    resetAuthentication Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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
    s3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    sharepointClientCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointClientSecret String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    sslCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    userId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    wasabiBucket String
    Wasabi: Bucket name
    wasabiRegion String
    Wasabi: Region
    wasabiSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    awsSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azureBlobStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    azureBlobStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azureFilesStorageAccessKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azureFilesStorageAccount string
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix string
    Azure Files: Custom DNS suffix
    azureFilesStorageSasToken string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azureFilesStorageShareName string
    Azure Files: Storage Share name
    backblazeB2ApplicationKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblazeB2Bucket string
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2KeyId string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflareSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    filebaseSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    filesAgentApiToken string
    Files Agent API Token
    filesAgentLatestVersion string
    Latest available Files Agent version
    filesAgentPermissionSet string
    Local permissions for files agent. read_only, write_only, 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
    filesApiKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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
    googleCloudStorageCredentialsJson string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    googleCloudStorageOauthScope 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.
    googleCloudStorageProjectId string
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    googleCloudStorageS3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname string
    Hostname or IP address
    linodeAccessKey string
    Linode: Access Key
    linodeBucket string
    Linode: Bucket name
    linodeRegion string
    Linode: region
    linodeSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    privateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    privateKeyPassphrase string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remoteHomePath string
    Initial home folder on remote server
    remoteServerCredentialId number
    ID of Remote Server Credential, if applicable.
    resetAuthentication boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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
    s3CompatibleSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    sharepointClientCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointClientSecret string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    sslCertificate string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    userId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username string
    Remote server username.
    wasabiAccessKey string
    Wasabi: Access Key.
    wasabiBucket string
    Wasabi: Bucket name
    wasabiRegion string
    Wasabi: Region
    wasabiSecretKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    aws_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azure_blob_storage_access_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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_blob_storage_sas_token str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azure_files_storage_access_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azure_files_storage_account str
    Azure Files: Storage Account name
    azure_files_storage_dns_suffix str
    Azure Files: Custom DNS suffix
    azure_files_storage_sas_token str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azure_files_storage_share_name str
    Azure Files: Storage Share name
    backblaze_b2_application_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblaze_b2_bucket str
    Backblaze B2 Cloud Storage: Bucket name
    backblaze_b2_key_id str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflare_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    filebase_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    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. read_only, write_only, 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 str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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_credentials_json str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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_oauth_scope str
    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 str
    Google Cloud Storage: Project ID
    google_cloud_storage_s3_compatible_access_key str
    Google Cloud Storage: S3-compatible Access Key.
    google_cloud_storage_s3_compatible_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname str
    Hostname or IP address
    linode_access_key str
    Linode: Access Key
    linode_bucket str
    Linode: Bucket name
    linode_region str
    Linode: region
    linode_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    private_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    private_key_passphrase str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remote_home_path str
    Initial home folder on remote server
    remote_server_credential_id int
    ID of Remote Server Credential, if applicable.
    reset_authentication bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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_certificate str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepoint_client_id str
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_client_secret str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    ssl_certificate str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    user_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username str
    Remote server username.
    wasabi_access_key str
    Wasabi: Access Key.
    wasabi_bucket str
    Wasabi: Bucket name
    wasabi_region str
    Wasabi: Region
    wasabi_secret_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    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.
    awsSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
    azureBlobStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: 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?
    azureBlobStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
    azureFilesStorageAccessKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
    azureFilesStorageAccount String
    Azure Files: Storage Account name
    azureFilesStorageDnsSuffix String
    Azure Files: Custom DNS suffix
    azureFilesStorageSasToken String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
    azureFilesStorageShareName String
    Azure Files: Storage Share name
    backblazeB2ApplicationKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
    backblazeB2Bucket String
    Backblaze B2 Cloud Storage: Bucket name
    backblazeB2KeyId String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
    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
    cloudflareSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
    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
    filebaseSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
    filesAgentApiToken String
    Files Agent API Token
    filesAgentLatestVersion String
    Latest available Files Agent version
    filesAgentPermissionSet String
    Local permissions for files agent. read_only, write_only, 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
    filesApiKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
    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
    googleCloudStorageCredentialsJson String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. 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
    googleCloudStorageOauthScope 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.
    googleCloudStorageProjectId String
    Google Cloud Storage: Project ID
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    googleCloudStorageS3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
    hostname String
    Hostname or IP address
    linodeAccessKey String
    Linode: Access Key
    linodeBucket String
    Linode: Bucket name
    linodeRegion String
    Linode: region
    linodeSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
    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
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
    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.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
    privateKeyPassphrase String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
    remoteHomePath String
    Initial home folder on remote server
    remoteServerCredentialId Number
    ID of Remote Server Credential, if applicable.
    resetAuthentication Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
    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
    s3CompatibleSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
    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.
    sharepointClientCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointClientSecret String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret 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?
    sslCertificate String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
    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.
    userId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    wasabiBucket String
    Wasabi: Bucket name
    wasabiRegion String
    Wasabi: Region
    wasabiSecretKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
    workspaceId Number
    Workspace ID (0 for default workspace)

    Import

    The pulumi import command can be used, for example:

    Remote Servers can be imported by specifying the id.

    $ pulumi import filescom:index/remoteServer:RemoteServer example_remote_server 1
    

    To learn more about importing existing cloud resources, see Importing resources.

    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