getSite

Files.com v0.1.1, Aug 20 26

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleSite = filescom.getSite({});

import pulumi
import pulumi_filescom as filescom

example_site = filescom.get_site()

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.GetSite(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleSite = Filescom.GetSite.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleSite = FilescomFunctions.getSite(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

    }
}

variables:
  exampleSite:
    fn::invoke:
      function: filescom:getSite
      arguments: {}

pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

data "filescom_getsite" "exampleSite" {
}

Using getSite

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

function getSite(opts?: InvokeOptions): Promise<GetSiteResult>
function getSiteOutput(opts?: InvokeOutputOptions): Output<GetSiteResult>

def get_site(opts: Optional[InvokeOptions] = None) -> GetSiteResult
def get_site_output(opts: Optional[InvokeOutputOptions] = None) -> Output[GetSiteResult]

func LookupSite(ctx *Context, opts ...InvokeOption) (*LookupSiteResult, error)
func LookupSiteOutput(ctx *Context, opts ...InvokeOption) LookupSiteResultOutput

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

public static class GetSite 
{
    public static Task<GetSiteResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetSiteResult> Invoke(InvokeOptions? opts = null)
    public static Output<GetSiteResult> Invoke(InvokeOutputOptions opts)
}

public static CompletableFuture<GetSiteResult> getSite(InvokeOptions options)
public static Output<GetSiteResult> getSite(InvokeOptions options)
public static Output<GetSiteResult> getSite(InvokeOutputOptions options)

fn::invoke:
  function: filescom:index/getSite:getSite
  arguments:
    # arguments dictionary

data "filescom_get_site" "name" {
    # arguments
}

getSite Result

The following output properties are available:

ActiveSftpHostKeyId int: Id of the currently selected custom SFTP Host Key
AdditionalTextFileTypes List<string>: Additional extensions that are considered text files
AdminUserId int: User ID for the main site administrator
AdminsBypassLockedSubfolders bool: Allow admins to bypass the locked subfolders setting.
AiFeatureAvailability object: Availability settings for AI features by user class
AllowBundleNames bool: Are manual Bundle names allowed?
AllowUserLevel2faOverride bool: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
AllowUserLevelAllowedIpOverride bool: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
AllowUserLevelSslOverride bool: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
Allowed2faMethodBypassForFtpSftpDav bool: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
Allowed2faMethodEmail bool: Is OTP via email two factor authentication allowed?
Allowed2faMethodSms bool: Is SMS two factor authentication allowed?
Allowed2faMethodStatic bool: Is OTP via static codes for two factor authentication allowed?
Allowed2faMethodTotp bool: Is TOTP two factor authentication allowed?
Allowed2faMethodWebauthn bool: Is WebAuthn two factor authentication allowed?
Allowed2faMethodYubi bool: Is yubikey two factor authentication allowed?
AllowedCountries string: Comma separated list of allowed Country codes
AllowedIps string: List of allowed IP addresses
AlwaysMkdirParents bool: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
As2MessageRetentionDays int: Number of days to retain AS2 messages (incoming and outgoing).
AskAboutOverwrites bool: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
BundleActivityNotifications string: Do Bundle owners receive activity notifications?
BundleExpiration int: Site-wide Bundle expiration in days
BundleNotFoundMessage string: Custom error message to show when bundle is not found.
BundlePasswordRequired bool: Do Bundles require password protection?
BundleRecipientBlacklistDomains List<string>: List of email domains to disallow when entering a Bundle/Inbox recipients
BundleRecipientBlacklistFreeEmailDomains bool: Disallow free email domains for Bundle/Inbox recipients?
BundleRegistrationNotifications string: Do Bundle owners receive registration notification?
BundleRequireNote bool: Do Bundles require internal notes?
BundleRequireRegistration bool: Do Bundles require registration?
BundleRequireShareRecipient bool: Do Bundles require recipients for sharing?
BundleSendOneTimePasswordToRecipientAtRegistration bool: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
BundleSendSharedReceipts bool: Do Bundle creators receive receipts of invitations?
BundleUploadReceiptNotifications string: Do Bundle uploaders receive upload confirmation notifications?
BundleWatermarkAttachment string: Preview watermark image applied to all bundle items.
BundleWatermarkValue object: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
BundlesDefaultOwnedByPrimaryGroup bool: If true, new Share Links created by a user with a primary group will default to that group as owner.
CalculateFileChecksumsCrc32 bool: Calculate CRC32 checksums for files?
CalculateFileChecksumsMd5 bool: Calculate MD5 checksums for files?
CalculateFileChecksumsSha1 bool: Calculate SHA1 checksums for files?
CalculateFileChecksumsSha256 bool: Calculate SHA256 checksums for files?
Color2Left string: Page link and button color
Color2Link string: Top bar link color
Color2Text string: Page link and button color
Color2Top string: Top bar background color
Color2TopText string: Top bar text color
ContactName string: Site main contact name
CreatedAt string: Time this site was created
Currency string: Preferred currency
CustomNamespace bool: Is this site using a custom namespace for users?
DavEnabled bool: Is WebDAV enabled?
DavUserRootEnabled bool: Use user FTP roots also for WebDAV?
DaysToRetainBackups int: Number of days to keep deleted files
DefaultTimeZone string: Site default time zone
DesktopApp bool: Is the desktop app enabled?
DesktopAppSessionIpPinning bool: Is desktop app session IP pinning enabled?
DesktopAppSessionLifetime int: Desktop app session lifetime (in hours)
DisableAllAiFeatures bool: If true, all AI features are disabled for this site.
DisableFilesCertificateGeneration bool: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
DisableNotifications bool: Are notifications disabled?
DisablePasswordReset bool: Is password reset disabled?
DisallowedCountries string: Comma separated list of disallowed Country codes
DocumentEditsInBundleAllowed bool: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
Domain string: Custom domain
DomainHstsHeader bool: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
DomainLetsencryptChain string: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
Email string: Main email for this site
EmailFooterCustomText string: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
Fedramp bool: Are FedRAMP security restrictions enabled for this site?
FolderPermissionsGroupsOnly bool: If true, permissions for this site must be bound to a group (not a user).
FtpEnabled bool: Is FTP enabled?
GroupAdminsCanAddUsers bool: Allow group admins to create users in their groups
GroupAdminsCanBypassUserLifecycleRules bool: Allow group admins to exempt users in their groups from lifecycle rules
GroupAdminsCanDeleteUsers bool: Allow group admins to delete users in their groups
GroupAdminsCanEnableDisableUsers bool: Allow group admins to enable or disable users in their groups
GroupAdminsCanManageGroupMemberships bool: Allow group admins to add or remove existing users in their groups
GroupAdminsCanModifyUsers bool: Allow group admins to modify users in their groups
GroupAdminsCanResetPasswords bool: Allow group admins to reset passwords for users in their groups
GroupAdminsCanSetUserPassword bool: Allow group admins to set password authentication method
Hipaa bool: Is there a signed HIPAA BAA between Files.com and this site?
Icon128 string: Branded icon 128x128
Icon16 string: Branded icon 16x16
Icon32 string: Branded icon 32x32
Icon48 string: Branded icon 48x48
Id int: Site Id
ImmutableFilesSetAt string: Can files be modified?
IncludePasswordInWelcomeEmail bool: Include password in emails to new users?
Language string: Site default language
LdapBaseDn string: Base DN for looking up users in LDAP server
LdapDomain string: Domain name that will be appended to usernames
LdapEnabled bool: Main LDAP setting: is LDAP enabled?
LdapGroupAction string: Should we sync groups from LDAP server?
LdapGroupExclusion string: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
LdapGroupInclusion string: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
LdapHost string: LDAP host
LdapHost2 string: LDAP backup host
LdapHost3 string: LDAP backup host
LdapPort int: LDAP port
LdapSecure bool: Use secure LDAP?
LdapType string: LDAP type
LdapUserAction string: Should we sync users from LDAP server?
LdapUserIncludeGroups string: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
LdapUsername string: Username for signing in to LDAP server.
LdapUsernameField string: LDAP username field
LegacyChecksumsMode bool: Use legacy checksums mode?
LoginHelpText string: Login help text
LoginPageBackgroundImage string: Branded login page background
Logo string: Branded logo
ManagedSiteSettings object: List of site settings managed by the parent site
MaxPriorPasswords int: Number of prior passwords to disallow
McpDcrEnabled bool: Is OAuth DCR (dynamic client registration) for MCP enabled?
MigrateRemoteServerSyncToSync bool: If true, we will migrate all remote server syncs to the new Sync model.
MobileApp bool: Is the mobile app enabled?
MobileAppSessionIpPinning bool: Is mobile app session IP pinning enabled?
MobileAppSessionLifetime int: Mobile app session lifetime (in hours)
MotdText string: A message to show users when they connect via FTP or SFTP.
MotdUseForFtp bool: Show message to users connecting via FTP
MotdUseForSftp bool: Show message to users connecting via SFTP
Name string: Site name
NextBillingAmount string: Next billing amount
NextBillingDate string: Next billing date
NonSsoGroupsAllowed bool: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
NonSsoUsersAllowed bool: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
OfficeIntegrationAvailable bool: If true, allows users to use a document editing integration.
OfficeIntegrationType string: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
OncehubLink string: Link to scheduling a meeting with our Sales team
OptOutGlobal bool: Use servers in the USA only?
Overdue bool: Is this site's billing overdue?
PasswordMinLength int: Shortest password length for users
PasswordRequireLetter bool: Require a letter in passwords?
PasswordRequireMixed bool: Require lower and upper case letters in passwords?
PasswordRequireNumber bool: Require a number in passwords?
PasswordRequireSpecial bool: Require special characters in password?
PasswordRequireUnbreached bool: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
PasswordRequirementsApplyToBundles bool: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
PasswordValidityDays int: Number of days password is valid
Phone string: Site phone number
PinAllRemoteServersToSiteRegion bool: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
PreventRootPermissionsForNonSiteAdmins bool: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
ProtocolAccessGroupsOnly bool: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
ReplyToEmail string: Reply-to email for this site
Require2fa bool: Require two-factor authentication for all users?
Require2faExemptAllSsoUsers bool: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
Require2faStopTime string: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
Require2faUserType string: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
RequireLogoutFromBundlesAndInboxes bool: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
RestrictRootFolderBehaviorsToSiteAdmins bool: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
RevokeBundleAccessOnDisableOrDelete bool: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
RootFolderBehaviorsApplyToWorkspaces bool: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
Session string: Current session
SessionExpiryMinutes int: Session expiry in minutes
SftpEnabled bool: Is SFTP enabled?
SftpFinalizePartialUploads bool: Finalize partial SFTP uploads from interrupted connections? Default: true.
SftpHostKeyType string: Sftp Host Key Type
SftpInsecureCiphers bool: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
SftpInsecureDiffieHellman bool: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
SftpUserRootEnabled bool: Use user FTP roots also for SFTP?
SharingEnabled bool: Allow bundle creation
ShowRequestAccessLink bool: Show request access link for users without access? Currently unused.
ShowUserNotificationsLogInLink bool: Show log in link in user notifications?
SiteFooter string: Custom site footer text for authenticated pages
SiteHeader string: Custom site header text for authenticated pages
SitePublicFooter string: Custom site footer text for public pages
SitePublicHeader string: Custom site header text for public pages
SmtpAddress string: SMTP server hostname or IP
SmtpAuthentication string: SMTP server authentication type
SmtpFrom string: From address to use when mailing through custom SMTP
SmtpPort int: SMTP server port
SmtpUsername string: SMTP server username
SnapshotSharingEnabled bool: Allow snapshot share links creation
SslRequired bool: Is SSL required? Disabling this is insecure.
Subdomain string: Site subdomain
SwitchToPlanDate string: If switching plans, when does the new plan take effect?
TrialDaysLeft int: Number of days left in trial
TrialUntil string: When does this Site trial expire?
UploadsViaEmailAuthentication bool: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
UseDedicatedIpsForSmtp bool: If using custom SMTP, should we use dedicated IPs to deliver emails?
UseProvidedModifiedAt bool: Allow uploaders to set providedModifiedAt for uploaded files?
User string: User of current session
UserLockout bool: Will users be locked out after incorrect login attempts?
UserLockoutLockPeriod int: How many hours to lock user out for failed password?
UserLockoutTries int: Number of login tries within userLockoutWithin hours before users are locked out
UserLockoutWithin int: Number of hours for user lockout window
UserRequestsEnabled bool: Enable User Requests feature
UserRequestsNotifyAdmins bool: Send email to site admins when a user request is received?
UsernameDisplay string: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
UsersCanCreateApiKeys bool: Allow users to create their own API keys?
UsersCanCreateSshKeys bool: Allow users to create their own SSH keys?
WelcomeCustomText string: Custom text send in user welcome email
WelcomeEmailCc string: Include this email in welcome emails if enabled
WelcomeEmailEnabled bool: Will the welcome email be sent to new users?
WelcomeEmailSubject string: Include this email subject in welcome emails if enabled
WelcomeScreen string: Does the welcome screen appear?
WindowsModeFtp bool: Does FTP user Windows emulation mode?

ActiveSftpHostKeyId int: Id of the currently selected custom SFTP Host Key
AdditionalTextFileTypes []string: Additional extensions that are considered text files
AdminUserId int: User ID for the main site administrator
AdminsBypassLockedSubfolders bool: Allow admins to bypass the locked subfolders setting.
AiFeatureAvailability interface{}: Availability settings for AI features by user class
AllowBundleNames bool: Are manual Bundle names allowed?
AllowUserLevel2faOverride bool: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
AllowUserLevelAllowedIpOverride bool: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
AllowUserLevelSslOverride bool: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
Allowed2faMethodBypassForFtpSftpDav bool: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
Allowed2faMethodEmail bool: Is OTP via email two factor authentication allowed?
Allowed2faMethodSms bool: Is SMS two factor authentication allowed?
Allowed2faMethodStatic bool: Is OTP via static codes for two factor authentication allowed?
Allowed2faMethodTotp bool: Is TOTP two factor authentication allowed?
Allowed2faMethodWebauthn bool: Is WebAuthn two factor authentication allowed?
Allowed2faMethodYubi bool: Is yubikey two factor authentication allowed?
AllowedCountries string: Comma separated list of allowed Country codes
AllowedIps string: List of allowed IP addresses
AlwaysMkdirParents bool: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
As2MessageRetentionDays int: Number of days to retain AS2 messages (incoming and outgoing).
AskAboutOverwrites bool: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
BundleActivityNotifications string: Do Bundle owners receive activity notifications?
BundleExpiration int: Site-wide Bundle expiration in days
BundleNotFoundMessage string: Custom error message to show when bundle is not found.
BundlePasswordRequired bool: Do Bundles require password protection?
BundleRecipientBlacklistDomains []string: List of email domains to disallow when entering a Bundle/Inbox recipients
BundleRecipientBlacklistFreeEmailDomains bool: Disallow free email domains for Bundle/Inbox recipients?
BundleRegistrationNotifications string: Do Bundle owners receive registration notification?
BundleRequireNote bool: Do Bundles require internal notes?
BundleRequireRegistration bool: Do Bundles require registration?
BundleRequireShareRecipient bool: Do Bundles require recipients for sharing?
BundleSendOneTimePasswordToRecipientAtRegistration bool: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
BundleSendSharedReceipts bool: Do Bundle creators receive receipts of invitations?
BundleUploadReceiptNotifications string: Do Bundle uploaders receive upload confirmation notifications?
BundleWatermarkAttachment string: Preview watermark image applied to all bundle items.
BundleWatermarkValue interface{}: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
BundlesDefaultOwnedByPrimaryGroup bool: If true, new Share Links created by a user with a primary group will default to that group as owner.
CalculateFileChecksumsCrc32 bool: Calculate CRC32 checksums for files?
CalculateFileChecksumsMd5 bool: Calculate MD5 checksums for files?
CalculateFileChecksumsSha1 bool: Calculate SHA1 checksums for files?
CalculateFileChecksumsSha256 bool: Calculate SHA256 checksums for files?
Color2Left string: Page link and button color
Color2Link string: Top bar link color
Color2Text string: Page link and button color
Color2Top string: Top bar background color
Color2TopText string: Top bar text color
ContactName string: Site main contact name
CreatedAt string: Time this site was created
Currency string: Preferred currency
CustomNamespace bool: Is this site using a custom namespace for users?
DavEnabled bool: Is WebDAV enabled?
DavUserRootEnabled bool: Use user FTP roots also for WebDAV?
DaysToRetainBackups int: Number of days to keep deleted files
DefaultTimeZone string: Site default time zone
DesktopApp bool: Is the desktop app enabled?
DesktopAppSessionIpPinning bool: Is desktop app session IP pinning enabled?
DesktopAppSessionLifetime int: Desktop app session lifetime (in hours)
DisableAllAiFeatures bool: If true, all AI features are disabled for this site.
DisableFilesCertificateGeneration bool: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
DisableNotifications bool: Are notifications disabled?
DisablePasswordReset bool: Is password reset disabled?
DisallowedCountries string: Comma separated list of disallowed Country codes
DocumentEditsInBundleAllowed bool: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
Domain string: Custom domain
DomainHstsHeader bool: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
DomainLetsencryptChain string: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
Email string: Main email for this site
EmailFooterCustomText string: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
Fedramp bool: Are FedRAMP security restrictions enabled for this site?
FolderPermissionsGroupsOnly bool: If true, permissions for this site must be bound to a group (not a user).
FtpEnabled bool: Is FTP enabled?
GroupAdminsCanAddUsers bool: Allow group admins to create users in their groups
GroupAdminsCanBypassUserLifecycleRules bool: Allow group admins to exempt users in their groups from lifecycle rules
GroupAdminsCanDeleteUsers bool: Allow group admins to delete users in their groups
GroupAdminsCanEnableDisableUsers bool: Allow group admins to enable or disable users in their groups
GroupAdminsCanManageGroupMemberships bool: Allow group admins to add or remove existing users in their groups
GroupAdminsCanModifyUsers bool: Allow group admins to modify users in their groups
GroupAdminsCanResetPasswords bool: Allow group admins to reset passwords for users in their groups
GroupAdminsCanSetUserPassword bool: Allow group admins to set password authentication method
Hipaa bool: Is there a signed HIPAA BAA between Files.com and this site?
Icon128 string: Branded icon 128x128
Icon16 string: Branded icon 16x16
Icon32 string: Branded icon 32x32
Icon48 string: Branded icon 48x48
Id int: Site Id
ImmutableFilesSetAt string: Can files be modified?
IncludePasswordInWelcomeEmail bool: Include password in emails to new users?
Language string: Site default language
LdapBaseDn string: Base DN for looking up users in LDAP server
LdapDomain string: Domain name that will be appended to usernames
LdapEnabled bool: Main LDAP setting: is LDAP enabled?
LdapGroupAction string: Should we sync groups from LDAP server?
LdapGroupExclusion string: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
LdapGroupInclusion string: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
LdapHost string: LDAP host
LdapHost2 string: LDAP backup host
LdapHost3 string: LDAP backup host
LdapPort int: LDAP port
LdapSecure bool: Use secure LDAP?
LdapType string: LDAP type
LdapUserAction string: Should we sync users from LDAP server?
LdapUserIncludeGroups string: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
LdapUsername string: Username for signing in to LDAP server.
LdapUsernameField string: LDAP username field
LegacyChecksumsMode bool: Use legacy checksums mode?
LoginHelpText string: Login help text
LoginPageBackgroundImage string: Branded login page background
Logo string: Branded logo
ManagedSiteSettings interface{}: List of site settings managed by the parent site
MaxPriorPasswords int: Number of prior passwords to disallow
McpDcrEnabled bool: Is OAuth DCR (dynamic client registration) for MCP enabled?
MigrateRemoteServerSyncToSync bool: If true, we will migrate all remote server syncs to the new Sync model.
MobileApp bool: Is the mobile app enabled?
MobileAppSessionIpPinning bool: Is mobile app session IP pinning enabled?
MobileAppSessionLifetime int: Mobile app session lifetime (in hours)
MotdText string: A message to show users when they connect via FTP or SFTP.
MotdUseForFtp bool: Show message to users connecting via FTP
MotdUseForSftp bool: Show message to users connecting via SFTP
Name string: Site name
NextBillingAmount string: Next billing amount
NextBillingDate string: Next billing date
NonSsoGroupsAllowed bool: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
NonSsoUsersAllowed bool: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
OfficeIntegrationAvailable bool: If true, allows users to use a document editing integration.
OfficeIntegrationType string: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
OncehubLink string: Link to scheduling a meeting with our Sales team
OptOutGlobal bool: Use servers in the USA only?
Overdue bool: Is this site's billing overdue?
PasswordMinLength int: Shortest password length for users
PasswordRequireLetter bool: Require a letter in passwords?
PasswordRequireMixed bool: Require lower and upper case letters in passwords?
PasswordRequireNumber bool: Require a number in passwords?
PasswordRequireSpecial bool: Require special characters in password?
PasswordRequireUnbreached bool: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
PasswordRequirementsApplyToBundles bool: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
PasswordValidityDays int: Number of days password is valid
Phone string: Site phone number
PinAllRemoteServersToSiteRegion bool: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
PreventRootPermissionsForNonSiteAdmins bool: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
ProtocolAccessGroupsOnly bool: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
ReplyToEmail string: Reply-to email for this site
Require2fa bool: Require two-factor authentication for all users?
Require2faExemptAllSsoUsers bool: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
Require2faStopTime string: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
Require2faUserType string: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
RequireLogoutFromBundlesAndInboxes bool: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
RestrictRootFolderBehaviorsToSiteAdmins bool: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
RevokeBundleAccessOnDisableOrDelete bool: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
RootFolderBehaviorsApplyToWorkspaces bool: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
Session string: Current session
SessionExpiryMinutes int: Session expiry in minutes
SftpEnabled bool: Is SFTP enabled?
SftpFinalizePartialUploads bool: Finalize partial SFTP uploads from interrupted connections? Default: true.
SftpHostKeyType string: Sftp Host Key Type
SftpInsecureCiphers bool: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
SftpInsecureDiffieHellman bool: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
SftpUserRootEnabled bool: Use user FTP roots also for SFTP?
SharingEnabled bool: Allow bundle creation
ShowRequestAccessLink bool: Show request access link for users without access? Currently unused.
ShowUserNotificationsLogInLink bool: Show log in link in user notifications?
SiteFooter string: Custom site footer text for authenticated pages
SiteHeader string: Custom site header text for authenticated pages
SitePublicFooter string: Custom site footer text for public pages
SitePublicHeader string: Custom site header text for public pages
SmtpAddress string: SMTP server hostname or IP
SmtpAuthentication string: SMTP server authentication type
SmtpFrom string: From address to use when mailing through custom SMTP
SmtpPort int: SMTP server port
SmtpUsername string: SMTP server username
SnapshotSharingEnabled bool: Allow snapshot share links creation
SslRequired bool: Is SSL required? Disabling this is insecure.
Subdomain string: Site subdomain
SwitchToPlanDate string: If switching plans, when does the new plan take effect?
TrialDaysLeft int: Number of days left in trial
TrialUntil string: When does this Site trial expire?
UploadsViaEmailAuthentication bool: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
UseDedicatedIpsForSmtp bool: If using custom SMTP, should we use dedicated IPs to deliver emails?
UseProvidedModifiedAt bool: Allow uploaders to set providedModifiedAt for uploaded files?
User string: User of current session
UserLockout bool: Will users be locked out after incorrect login attempts?
UserLockoutLockPeriod int: How many hours to lock user out for failed password?
UserLockoutTries int: Number of login tries within userLockoutWithin hours before users are locked out
UserLockoutWithin int: Number of hours for user lockout window
UserRequestsEnabled bool: Enable User Requests feature
UserRequestsNotifyAdmins bool: Send email to site admins when a user request is received?
UsernameDisplay string: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
UsersCanCreateApiKeys bool: Allow users to create their own API keys?
UsersCanCreateSshKeys bool: Allow users to create their own SSH keys?
WelcomeCustomText string: Custom text send in user welcome email
WelcomeEmailCc string: Include this email in welcome emails if enabled
WelcomeEmailEnabled bool: Will the welcome email be sent to new users?
WelcomeEmailSubject string: Include this email subject in welcome emails if enabled
WelcomeScreen string: Does the welcome screen appear?
WindowsModeFtp bool: Does FTP user Windows emulation mode?

active_sftp_host_key_id number: Id of the currently selected custom SFTP Host Key
additional_text_file_types list(string): Additional extensions that are considered text files
admin_user_id number: User ID for the main site administrator
admins_bypass_locked_subfolders bool: Allow admins to bypass the locked subfolders setting.
ai_feature_availability any: Availability settings for AI features by user class
allow_bundle_names bool: Are manual Bundle names allowed?
allow_user_level2fa_override bool: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
allow_user_level_allowed_ip_override bool: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
allow_user_level_ssl_override bool: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
allowed2fa_method_bypass_for_ftp_sftp_dav bool: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
allowed2fa_method_email bool: Is OTP via email two factor authentication allowed?
allowed2fa_method_sms bool: Is SMS two factor authentication allowed?
allowed2fa_method_static bool: Is OTP via static codes for two factor authentication allowed?
allowed2fa_method_totp bool: Is TOTP two factor authentication allowed?
allowed2fa_method_webauthn bool: Is WebAuthn two factor authentication allowed?
allowed2fa_method_yubi bool: Is yubikey two factor authentication allowed?
allowed_countries string: Comma separated list of allowed Country codes
allowed_ips string: List of allowed IP addresses
always_mkdir_parents bool: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
as2_message_retention_days number: Number of days to retain AS2 messages (incoming and outgoing).
ask_about_overwrites bool: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
bundle_activity_notifications string: Do Bundle owners receive activity notifications?
bundle_expiration number: Site-wide Bundle expiration in days
bundle_not_found_message string: Custom error message to show when bundle is not found.
bundle_password_required bool: Do Bundles require password protection?
bundle_recipient_blacklist_domains list(string): List of email domains to disallow when entering a Bundle/Inbox recipients
bundle_recipient_blacklist_free_email_domains bool: Disallow free email domains for Bundle/Inbox recipients?
bundle_registration_notifications string: Do Bundle owners receive registration notification?
bundle_require_note bool: Do Bundles require internal notes?
bundle_require_registration bool: Do Bundles require registration?
bundle_require_share_recipient bool: Do Bundles require recipients for sharing?
bundle_send_one_time_password_to_recipient_at_registration bool: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
bundle_send_shared_receipts bool: Do Bundle creators receive receipts of invitations?
bundle_upload_receipt_notifications string: Do Bundle uploaders receive upload confirmation notifications?
bundle_watermark_attachment string: Preview watermark image applied to all bundle items.
bundle_watermark_value any: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
bundles_default_owned_by_primary_group bool: If true, new Share Links created by a user with a primary group will default to that group as owner.
calculate_file_checksums_crc32 bool: Calculate CRC32 checksums for files?
calculate_file_checksums_md5 bool: Calculate MD5 checksums for files?
calculate_file_checksums_sha1 bool: Calculate SHA1 checksums for files?
calculate_file_checksums_sha256 bool: Calculate SHA256 checksums for files?
color2_left string: Page link and button color
color2_link string: Top bar link color
color2_text string: Page link and button color
color2_top string: Top bar background color
color2_top_text string: Top bar text color
contact_name string: Site main contact name
created_at string: Time this site was created
currency string: Preferred currency
custom_namespace bool: Is this site using a custom namespace for users?
dav_enabled bool: Is WebDAV enabled?
dav_user_root_enabled bool: Use user FTP roots also for WebDAV?
days_to_retain_backups number: Number of days to keep deleted files
default_time_zone string: Site default time zone
desktop_app bool: Is the desktop app enabled?
desktop_app_session_ip_pinning bool: Is desktop app session IP pinning enabled?
desktop_app_session_lifetime number: Desktop app session lifetime (in hours)
disable_all_ai_features bool: If true, all AI features are disabled for this site.
disable_files_certificate_generation bool: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
disable_notifications bool: Are notifications disabled?
disable_password_reset bool: Is password reset disabled?
disallowed_countries string: Comma separated list of disallowed Country codes
document_edits_in_bundle_allowed bool: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
domain string: Custom domain
domain_hsts_header bool: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domain_letsencrypt_chain string: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
email string: Main email for this site
email_footer_custom_text string: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
fedramp bool: Are FedRAMP security restrictions enabled for this site?
folder_permissions_groups_only bool: If true, permissions for this site must be bound to a group (not a user).
ftp_enabled bool: Is FTP enabled?
group_admins_can_add_users bool: Allow group admins to create users in their groups
group_admins_can_bypass_user_lifecycle_rules bool: Allow group admins to exempt users in their groups from lifecycle rules
group_admins_can_delete_users bool: Allow group admins to delete users in their groups
group_admins_can_enable_disable_users bool: Allow group admins to enable or disable users in their groups
group_admins_can_manage_group_memberships bool: Allow group admins to add or remove existing users in their groups
group_admins_can_modify_users bool: Allow group admins to modify users in their groups
group_admins_can_reset_passwords bool: Allow group admins to reset passwords for users in their groups
group_admins_can_set_user_password bool: Allow group admins to set password authentication method
hipaa bool: Is there a signed HIPAA BAA between Files.com and this site?
icon128 string: Branded icon 128x128
icon16 string: Branded icon 16x16
icon32 string: Branded icon 32x32
icon48 string: Branded icon 48x48
id number: Site Id
immutable_files_set_at string: Can files be modified?
include_password_in_welcome_email bool: Include password in emails to new users?
language string: Site default language
ldap_base_dn string: Base DN for looking up users in LDAP server
ldap_domain string: Domain name that will be appended to usernames
ldap_enabled bool: Main LDAP setting: is LDAP enabled?
ldap_group_action string: Should we sync groups from LDAP server?
ldap_group_exclusion string: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
ldap_group_inclusion string: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
ldap_host string: LDAP host
ldap_host2 string: LDAP backup host
ldap_host3 string: LDAP backup host
ldap_port number: LDAP port
ldap_secure bool: Use secure LDAP?
ldap_type string: LDAP type
ldap_user_action string: Should we sync users from LDAP server?
ldap_user_include_groups string: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
ldap_username string: Username for signing in to LDAP server.
ldap_username_field string: LDAP username field
legacy_checksums_mode bool: Use legacy checksums mode?
login_help_text string: Login help text
login_page_background_image string: Branded login page background
logo string: Branded logo
managed_site_settings any: List of site settings managed by the parent site
max_prior_passwords number: Number of prior passwords to disallow
mcp_dcr_enabled bool: Is OAuth DCR (dynamic client registration) for MCP enabled?
migrate_remote_server_sync_to_sync bool: If true, we will migrate all remote server syncs to the new Sync model.
mobile_app bool: Is the mobile app enabled?
mobile_app_session_ip_pinning bool: Is mobile app session IP pinning enabled?
mobile_app_session_lifetime number: Mobile app session lifetime (in hours)
motd_text string: A message to show users when they connect via FTP or SFTP.
motd_use_for_ftp bool: Show message to users connecting via FTP
motd_use_for_sftp bool: Show message to users connecting via SFTP
name string: Site name
next_billing_amount string: Next billing amount
next_billing_date string: Next billing date
non_sso_groups_allowed bool: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
non_sso_users_allowed bool: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
office_integration_available bool: If true, allows users to use a document editing integration.
office_integration_type string: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
oncehub_link string: Link to scheduling a meeting with our Sales team
opt_out_global bool: Use servers in the USA only?
overdue bool: Is this site's billing overdue?
password_min_length number: Shortest password length for users
password_require_letter bool: Require a letter in passwords?
password_require_mixed bool: Require lower and upper case letters in passwords?
password_require_number bool: Require a number in passwords?
password_require_special bool: Require special characters in password?
password_require_unbreached bool: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
password_requirements_apply_to_bundles bool: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
password_validity_days number: Number of days password is valid
phone string: Site phone number
pin_all_remote_servers_to_site_region bool: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
prevent_root_permissions_for_non_site_admins bool: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
protocol_access_groups_only bool: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
reply_to_email string: Reply-to email for this site
require2fa bool: Require two-factor authentication for all users?
require2fa_exempt_all_sso_users bool: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
require2fa_stop_time string: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
require2fa_user_type string: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
require_logout_from_bundles_and_inboxes bool: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
restrict_root_folder_behaviors_to_site_admins bool: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
revoke_bundle_access_on_disable_or_delete bool: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
root_folder_behaviors_apply_to_workspaces bool: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
session string: Current session
session_expiry_minutes number: Session expiry in minutes
sftp_enabled bool: Is SFTP enabled?
sftp_finalize_partial_uploads bool: Finalize partial SFTP uploads from interrupted connections? Default: true.
sftp_host_key_type string: Sftp Host Key Type
sftp_insecure_ciphers bool: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
sftp_insecure_diffie_hellman bool: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
sftp_user_root_enabled bool: Use user FTP roots also for SFTP?
sharing_enabled bool: Allow bundle creation
show_request_access_link bool: Show request access link for users without access? Currently unused.
show_user_notifications_log_in_link bool: Show log in link in user notifications?
site_footer string: Custom site footer text for authenticated pages
site_header string: Custom site header text for authenticated pages
site_public_footer string: Custom site footer text for public pages
site_public_header string: Custom site header text for public pages
smtp_address string: SMTP server hostname or IP
smtp_authentication string: SMTP server authentication type
smtp_from string: From address to use when mailing through custom SMTP
smtp_port number: SMTP server port
smtp_username string: SMTP server username
snapshot_sharing_enabled bool: Allow snapshot share links creation
ssl_required bool: Is SSL required? Disabling this is insecure.
subdomain string: Site subdomain
switch_to_plan_date string: If switching plans, when does the new plan take effect?
trial_days_left number: Number of days left in trial
trial_until string: When does this Site trial expire?
uploads_via_email_authentication bool: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
use_dedicated_ips_for_smtp bool: If using custom SMTP, should we use dedicated IPs to deliver emails?
use_provided_modified_at bool: Allow uploaders to set providedModifiedAt for uploaded files?
user string: User of current session
user_lockout bool: Will users be locked out after incorrect login attempts?
user_lockout_lock_period number: How many hours to lock user out for failed password?
user_lockout_tries number: Number of login tries within userLockoutWithin hours before users are locked out
user_lockout_within number: Number of hours for user lockout window
user_requests_enabled bool: Enable User Requests feature
user_requests_notify_admins bool: Send email to site admins when a user request is received?
username_display string: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
users_can_create_api_keys bool: Allow users to create their own API keys?
users_can_create_ssh_keys bool: Allow users to create their own SSH keys?
welcome_custom_text string: Custom text send in user welcome email
welcome_email_cc string: Include this email in welcome emails if enabled
welcome_email_enabled bool: Will the welcome email be sent to new users?
welcome_email_subject string: Include this email subject in welcome emails if enabled
welcome_screen string: Does the welcome screen appear?
windows_mode_ftp bool: Does FTP user Windows emulation mode?

activeSftpHostKeyId Integer: Id of the currently selected custom SFTP Host Key
additionalTextFileTypes List<String>: Additional extensions that are considered text files
adminUserId Integer: User ID for the main site administrator
adminsBypassLockedSubfolders Boolean: Allow admins to bypass the locked subfolders setting.
aiFeatureAvailability Object: Availability settings for AI features by user class
allowBundleNames Boolean: Are manual Bundle names allowed?
allowUserLevel2faOverride Boolean: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
allowUserLevelAllowedIpOverride Boolean: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
allowUserLevelSslOverride Boolean: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
allowed2faMethodBypassForFtpSftpDav Boolean: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
allowed2faMethodEmail Boolean: Is OTP via email two factor authentication allowed?
allowed2faMethodSms Boolean: Is SMS two factor authentication allowed?
allowed2faMethodStatic Boolean: Is OTP via static codes for two factor authentication allowed?
allowed2faMethodTotp Boolean: Is TOTP two factor authentication allowed?
allowed2faMethodWebauthn Boolean: Is WebAuthn two factor authentication allowed?
allowed2faMethodYubi Boolean: Is yubikey two factor authentication allowed?
allowedCountries String: Comma separated list of allowed Country codes
allowedIps String: List of allowed IP addresses
alwaysMkdirParents Boolean: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
as2MessageRetentionDays Integer: Number of days to retain AS2 messages (incoming and outgoing).
askAboutOverwrites Boolean: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
bundleActivityNotifications String: Do Bundle owners receive activity notifications?
bundleExpiration Integer: Site-wide Bundle expiration in days
bundleNotFoundMessage String: Custom error message to show when bundle is not found.
bundlePasswordRequired Boolean: Do Bundles require password protection?
bundleRecipientBlacklistDomains List<String>: List of email domains to disallow when entering a Bundle/Inbox recipients
bundleRecipientBlacklistFreeEmailDomains Boolean: Disallow free email domains for Bundle/Inbox recipients?
bundleRegistrationNotifications String: Do Bundle owners receive registration notification?
bundleRequireNote Boolean: Do Bundles require internal notes?
bundleRequireRegistration Boolean: Do Bundles require registration?
bundleRequireShareRecipient Boolean: Do Bundles require recipients for sharing?
bundleSendOneTimePasswordToRecipientAtRegistration Boolean: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
bundleSendSharedReceipts Boolean: Do Bundle creators receive receipts of invitations?
bundleUploadReceiptNotifications String: Do Bundle uploaders receive upload confirmation notifications?
bundleWatermarkAttachment String: Preview watermark image applied to all bundle items.
bundleWatermarkValue Object: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
bundlesDefaultOwnedByPrimaryGroup Boolean: If true, new Share Links created by a user with a primary group will default to that group as owner.
calculateFileChecksumsCrc32 Boolean: Calculate CRC32 checksums for files?
calculateFileChecksumsMd5 Boolean: Calculate MD5 checksums for files?
calculateFileChecksumsSha1 Boolean: Calculate SHA1 checksums for files?
calculateFileChecksumsSha256 Boolean: Calculate SHA256 checksums for files?
color2Left String: Page link and button color
color2Link String: Top bar link color
color2Text String: Page link and button color
color2Top String: Top bar background color
color2TopText String: Top bar text color
contactName String: Site main contact name
createdAt String: Time this site was created
currency String: Preferred currency
customNamespace Boolean: Is this site using a custom namespace for users?
davEnabled Boolean: Is WebDAV enabled?
davUserRootEnabled Boolean: Use user FTP roots also for WebDAV?
daysToRetainBackups Integer: Number of days to keep deleted files
defaultTimeZone String: Site default time zone
desktopApp Boolean: Is the desktop app enabled?
desktopAppSessionIpPinning Boolean: Is desktop app session IP pinning enabled?
desktopAppSessionLifetime Integer: Desktop app session lifetime (in hours)
disableAllAiFeatures Boolean: If true, all AI features are disabled for this site.
disableFilesCertificateGeneration Boolean: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
disableNotifications Boolean: Are notifications disabled?
disablePasswordReset Boolean: Is password reset disabled?
disallowedCountries String: Comma separated list of disallowed Country codes
documentEditsInBundleAllowed Boolean: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
domain String: Custom domain
domainHstsHeader Boolean: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domainLetsencryptChain String: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
email String: Main email for this site
emailFooterCustomText String: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
fedramp Boolean: Are FedRAMP security restrictions enabled for this site?
folderPermissionsGroupsOnly Boolean: If true, permissions for this site must be bound to a group (not a user).
ftpEnabled Boolean: Is FTP enabled?
groupAdminsCanAddUsers Boolean: Allow group admins to create users in their groups
groupAdminsCanBypassUserLifecycleRules Boolean: Allow group admins to exempt users in their groups from lifecycle rules
groupAdminsCanDeleteUsers Boolean: Allow group admins to delete users in their groups
groupAdminsCanEnableDisableUsers Boolean: Allow group admins to enable or disable users in their groups
groupAdminsCanManageGroupMemberships Boolean: Allow group admins to add or remove existing users in their groups
groupAdminsCanModifyUsers Boolean: Allow group admins to modify users in their groups
groupAdminsCanResetPasswords Boolean: Allow group admins to reset passwords for users in their groups
groupAdminsCanSetUserPassword Boolean: Allow group admins to set password authentication method
hipaa Boolean: Is there a signed HIPAA BAA between Files.com and this site?
icon128 String: Branded icon 128x128
icon16 String: Branded icon 16x16
icon32 String: Branded icon 32x32
icon48 String: Branded icon 48x48
id Integer: Site Id
immutableFilesSetAt String: Can files be modified?
includePasswordInWelcomeEmail Boolean: Include password in emails to new users?
language String: Site default language
ldapBaseDn String: Base DN for looking up users in LDAP server
ldapDomain String: Domain name that will be appended to usernames
ldapEnabled Boolean: Main LDAP setting: is LDAP enabled?
ldapGroupAction String: Should we sync groups from LDAP server?
ldapGroupExclusion String: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
ldapGroupInclusion String: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
ldapHost String: LDAP host
ldapHost2 String: LDAP backup host
ldapHost3 String: LDAP backup host
ldapPort Integer: LDAP port
ldapSecure Boolean: Use secure LDAP?
ldapType String: LDAP type
ldapUserAction String: Should we sync users from LDAP server?
ldapUserIncludeGroups String: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
ldapUsername String: Username for signing in to LDAP server.
ldapUsernameField String: LDAP username field
legacyChecksumsMode Boolean: Use legacy checksums mode?
loginHelpText String: Login help text
loginPageBackgroundImage String: Branded login page background
logo String: Branded logo
managedSiteSettings Object: List of site settings managed by the parent site
maxPriorPasswords Integer: Number of prior passwords to disallow
mcpDcrEnabled Boolean: Is OAuth DCR (dynamic client registration) for MCP enabled?
migrateRemoteServerSyncToSync Boolean: If true, we will migrate all remote server syncs to the new Sync model.
mobileApp Boolean: Is the mobile app enabled?
mobileAppSessionIpPinning Boolean: Is mobile app session IP pinning enabled?
mobileAppSessionLifetime Integer: Mobile app session lifetime (in hours)
motdText String: A message to show users when they connect via FTP or SFTP.
motdUseForFtp Boolean: Show message to users connecting via FTP
motdUseForSftp Boolean: Show message to users connecting via SFTP
name String: Site name
nextBillingAmount String: Next billing amount
nextBillingDate String: Next billing date
nonSsoGroupsAllowed Boolean: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
nonSsoUsersAllowed Boolean: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
officeIntegrationAvailable Boolean: If true, allows users to use a document editing integration.
officeIntegrationType String: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
oncehubLink String: Link to scheduling a meeting with our Sales team
optOutGlobal Boolean: Use servers in the USA only?
overdue Boolean: Is this site's billing overdue?
passwordMinLength Integer: Shortest password length for users
passwordRequireLetter Boolean: Require a letter in passwords?
passwordRequireMixed Boolean: Require lower and upper case letters in passwords?
passwordRequireNumber Boolean: Require a number in passwords?
passwordRequireSpecial Boolean: Require special characters in password?
passwordRequireUnbreached Boolean: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
passwordRequirementsApplyToBundles Boolean: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
passwordValidityDays Integer: Number of days password is valid
phone String: Site phone number
pinAllRemoteServersToSiteRegion Boolean: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
preventRootPermissionsForNonSiteAdmins Boolean: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
protocolAccessGroupsOnly Boolean: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
replyToEmail String: Reply-to email for this site
require2fa Boolean: Require two-factor authentication for all users?
require2faExemptAllSsoUsers Boolean: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
require2faStopTime String: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
require2faUserType String: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
requireLogoutFromBundlesAndInboxes Boolean: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
restrictRootFolderBehaviorsToSiteAdmins Boolean: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
revokeBundleAccessOnDisableOrDelete Boolean: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
rootFolderBehaviorsApplyToWorkspaces Boolean: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
session String: Current session
sessionExpiryMinutes Integer: Session expiry in minutes
sftpEnabled Boolean: Is SFTP enabled?
sftpFinalizePartialUploads Boolean: Finalize partial SFTP uploads from interrupted connections? Default: true.
sftpHostKeyType String: Sftp Host Key Type
sftpInsecureCiphers Boolean: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
sftpInsecureDiffieHellman Boolean: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
sftpUserRootEnabled Boolean: Use user FTP roots also for SFTP?
sharingEnabled Boolean: Allow bundle creation
showRequestAccessLink Boolean: Show request access link for users without access? Currently unused.
showUserNotificationsLogInLink Boolean: Show log in link in user notifications?
siteFooter String: Custom site footer text for authenticated pages
siteHeader String: Custom site header text for authenticated pages
sitePublicFooter String: Custom site footer text for public pages
sitePublicHeader String: Custom site header text for public pages
smtpAddress String: SMTP server hostname or IP
smtpAuthentication String: SMTP server authentication type
smtpFrom String: From address to use when mailing through custom SMTP
smtpPort Integer: SMTP server port
smtpUsername String: SMTP server username
snapshotSharingEnabled Boolean: Allow snapshot share links creation
sslRequired Boolean: Is SSL required? Disabling this is insecure.
subdomain String: Site subdomain
switchToPlanDate String: If switching plans, when does the new plan take effect?
trialDaysLeft Integer: Number of days left in trial
trialUntil String: When does this Site trial expire?
uploadsViaEmailAuthentication Boolean: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
useDedicatedIpsForSmtp Boolean: If using custom SMTP, should we use dedicated IPs to deliver emails?
useProvidedModifiedAt Boolean: Allow uploaders to set providedModifiedAt for uploaded files?
user String: User of current session
userLockout Boolean: Will users be locked out after incorrect login attempts?
userLockoutLockPeriod Integer: How many hours to lock user out for failed password?
userLockoutTries Integer: Number of login tries within userLockoutWithin hours before users are locked out
userLockoutWithin Integer: Number of hours for user lockout window
userRequestsEnabled Boolean: Enable User Requests feature
userRequestsNotifyAdmins Boolean: Send email to site admins when a user request is received?
usernameDisplay String: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
usersCanCreateApiKeys Boolean: Allow users to create their own API keys?
usersCanCreateSshKeys Boolean: Allow users to create their own SSH keys?
welcomeCustomText String: Custom text send in user welcome email
welcomeEmailCc String: Include this email in welcome emails if enabled
welcomeEmailEnabled Boolean: Will the welcome email be sent to new users?
welcomeEmailSubject String: Include this email subject in welcome emails if enabled
welcomeScreen String: Does the welcome screen appear?
windowsModeFtp Boolean: Does FTP user Windows emulation mode?

activeSftpHostKeyId number: Id of the currently selected custom SFTP Host Key
additionalTextFileTypes string[]: Additional extensions that are considered text files
adminUserId number: User ID for the main site administrator
adminsBypassLockedSubfolders boolean: Allow admins to bypass the locked subfolders setting.
aiFeatureAvailability any: Availability settings for AI features by user class
allowBundleNames boolean: Are manual Bundle names allowed?
allowUserLevel2faOverride boolean: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
allowUserLevelAllowedIpOverride boolean: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
allowUserLevelSslOverride boolean: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
allowed2faMethodBypassForFtpSftpDav boolean: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
allowed2faMethodEmail boolean: Is OTP via email two factor authentication allowed?
allowed2faMethodSms boolean: Is SMS two factor authentication allowed?
allowed2faMethodStatic boolean: Is OTP via static codes for two factor authentication allowed?
allowed2faMethodTotp boolean: Is TOTP two factor authentication allowed?
allowed2faMethodWebauthn boolean: Is WebAuthn two factor authentication allowed?
allowed2faMethodYubi boolean: Is yubikey two factor authentication allowed?
allowedCountries string: Comma separated list of allowed Country codes
allowedIps string: List of allowed IP addresses
alwaysMkdirParents boolean: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
as2MessageRetentionDays number: Number of days to retain AS2 messages (incoming and outgoing).
askAboutOverwrites boolean: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
bundleActivityNotifications string: Do Bundle owners receive activity notifications?
bundleExpiration number: Site-wide Bundle expiration in days
bundleNotFoundMessage string: Custom error message to show when bundle is not found.
bundlePasswordRequired boolean: Do Bundles require password protection?
bundleRecipientBlacklistDomains string[]: List of email domains to disallow when entering a Bundle/Inbox recipients
bundleRecipientBlacklistFreeEmailDomains boolean: Disallow free email domains for Bundle/Inbox recipients?
bundleRegistrationNotifications string: Do Bundle owners receive registration notification?
bundleRequireNote boolean: Do Bundles require internal notes?
bundleRequireRegistration boolean: Do Bundles require registration?
bundleRequireShareRecipient boolean: Do Bundles require recipients for sharing?
bundleSendOneTimePasswordToRecipientAtRegistration boolean: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
bundleSendSharedReceipts boolean: Do Bundle creators receive receipts of invitations?
bundleUploadReceiptNotifications string: Do Bundle uploaders receive upload confirmation notifications?
bundleWatermarkAttachment string: Preview watermark image applied to all bundle items.
bundleWatermarkValue any: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
bundlesDefaultOwnedByPrimaryGroup boolean: If true, new Share Links created by a user with a primary group will default to that group as owner.
calculateFileChecksumsCrc32 boolean: Calculate CRC32 checksums for files?
calculateFileChecksumsMd5 boolean: Calculate MD5 checksums for files?
calculateFileChecksumsSha1 boolean: Calculate SHA1 checksums for files?
calculateFileChecksumsSha256 boolean: Calculate SHA256 checksums for files?
color2Left string: Page link and button color
color2Link string: Top bar link color
color2Text string: Page link and button color
color2Top string: Top bar background color
color2TopText string: Top bar text color
contactName string: Site main contact name
createdAt string: Time this site was created
currency string: Preferred currency
customNamespace boolean: Is this site using a custom namespace for users?
davEnabled boolean: Is WebDAV enabled?
davUserRootEnabled boolean: Use user FTP roots also for WebDAV?
daysToRetainBackups number: Number of days to keep deleted files
defaultTimeZone string: Site default time zone
desktopApp boolean: Is the desktop app enabled?
desktopAppSessionIpPinning boolean: Is desktop app session IP pinning enabled?
desktopAppSessionLifetime number: Desktop app session lifetime (in hours)
disableAllAiFeatures boolean: If true, all AI features are disabled for this site.
disableFilesCertificateGeneration boolean: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
disableNotifications boolean: Are notifications disabled?
disablePasswordReset boolean: Is password reset disabled?
disallowedCountries string: Comma separated list of disallowed Country codes
documentEditsInBundleAllowed boolean: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
domain string: Custom domain
domainHstsHeader boolean: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domainLetsencryptChain string: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
email string: Main email for this site
emailFooterCustomText string: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
fedramp boolean: Are FedRAMP security restrictions enabled for this site?
folderPermissionsGroupsOnly boolean: If true, permissions for this site must be bound to a group (not a user).
ftpEnabled boolean: Is FTP enabled?
groupAdminsCanAddUsers boolean: Allow group admins to create users in their groups
groupAdminsCanBypassUserLifecycleRules boolean: Allow group admins to exempt users in their groups from lifecycle rules
groupAdminsCanDeleteUsers boolean: Allow group admins to delete users in their groups
groupAdminsCanEnableDisableUsers boolean: Allow group admins to enable or disable users in their groups
groupAdminsCanManageGroupMemberships boolean: Allow group admins to add or remove existing users in their groups
groupAdminsCanModifyUsers boolean: Allow group admins to modify users in their groups
groupAdminsCanResetPasswords boolean: Allow group admins to reset passwords for users in their groups
groupAdminsCanSetUserPassword boolean: Allow group admins to set password authentication method
hipaa boolean: Is there a signed HIPAA BAA between Files.com and this site?
icon128 string: Branded icon 128x128
icon16 string: Branded icon 16x16
icon32 string: Branded icon 32x32
icon48 string: Branded icon 48x48
id number: Site Id
immutableFilesSetAt string: Can files be modified?
includePasswordInWelcomeEmail boolean: Include password in emails to new users?
language string: Site default language
ldapBaseDn string: Base DN for looking up users in LDAP server
ldapDomain string: Domain name that will be appended to usernames
ldapEnabled boolean: Main LDAP setting: is LDAP enabled?
ldapGroupAction string: Should we sync groups from LDAP server?
ldapGroupExclusion string: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
ldapGroupInclusion string: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
ldapHost string: LDAP host
ldapHost2 string: LDAP backup host
ldapHost3 string: LDAP backup host
ldapPort number: LDAP port
ldapSecure boolean: Use secure LDAP?
ldapType string: LDAP type
ldapUserAction string: Should we sync users from LDAP server?
ldapUserIncludeGroups string: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
ldapUsername string: Username for signing in to LDAP server.
ldapUsernameField string: LDAP username field
legacyChecksumsMode boolean: Use legacy checksums mode?
loginHelpText string: Login help text
loginPageBackgroundImage string: Branded login page background
logo string: Branded logo
managedSiteSettings any: List of site settings managed by the parent site
maxPriorPasswords number: Number of prior passwords to disallow
mcpDcrEnabled boolean: Is OAuth DCR (dynamic client registration) for MCP enabled?
migrateRemoteServerSyncToSync boolean: If true, we will migrate all remote server syncs to the new Sync model.
mobileApp boolean: Is the mobile app enabled?
mobileAppSessionIpPinning boolean: Is mobile app session IP pinning enabled?
mobileAppSessionLifetime number: Mobile app session lifetime (in hours)
motdText string: A message to show users when they connect via FTP or SFTP.
motdUseForFtp boolean: Show message to users connecting via FTP
motdUseForSftp boolean: Show message to users connecting via SFTP
name string: Site name
nextBillingAmount string: Next billing amount
nextBillingDate string: Next billing date
nonSsoGroupsAllowed boolean: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
nonSsoUsersAllowed boolean: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
officeIntegrationAvailable boolean: If true, allows users to use a document editing integration.
officeIntegrationType string: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
oncehubLink string: Link to scheduling a meeting with our Sales team
optOutGlobal boolean: Use servers in the USA only?
overdue boolean: Is this site's billing overdue?
passwordMinLength number: Shortest password length for users
passwordRequireLetter boolean: Require a letter in passwords?
passwordRequireMixed boolean: Require lower and upper case letters in passwords?
passwordRequireNumber boolean: Require a number in passwords?
passwordRequireSpecial boolean: Require special characters in password?
passwordRequireUnbreached boolean: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
passwordRequirementsApplyToBundles boolean: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
passwordValidityDays number: Number of days password is valid
phone string: Site phone number
pinAllRemoteServersToSiteRegion boolean: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
preventRootPermissionsForNonSiteAdmins boolean: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
protocolAccessGroupsOnly boolean: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
replyToEmail string: Reply-to email for this site
require2fa boolean: Require two-factor authentication for all users?
require2faExemptAllSsoUsers boolean: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
require2faStopTime string: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
require2faUserType string: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
requireLogoutFromBundlesAndInboxes boolean: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
restrictRootFolderBehaviorsToSiteAdmins boolean: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
revokeBundleAccessOnDisableOrDelete boolean: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
rootFolderBehaviorsApplyToWorkspaces boolean: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
session string: Current session
sessionExpiryMinutes number: Session expiry in minutes
sftpEnabled boolean: Is SFTP enabled?
sftpFinalizePartialUploads boolean: Finalize partial SFTP uploads from interrupted connections? Default: true.
sftpHostKeyType string: Sftp Host Key Type
sftpInsecureCiphers boolean: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
sftpInsecureDiffieHellman boolean: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
sftpUserRootEnabled boolean: Use user FTP roots also for SFTP?
sharingEnabled boolean: Allow bundle creation
showRequestAccessLink boolean: Show request access link for users without access? Currently unused.
showUserNotificationsLogInLink boolean: Show log in link in user notifications?
siteFooter string: Custom site footer text for authenticated pages
siteHeader string: Custom site header text for authenticated pages
sitePublicFooter string: Custom site footer text for public pages
sitePublicHeader string: Custom site header text for public pages
smtpAddress string: SMTP server hostname or IP
smtpAuthentication string: SMTP server authentication type
smtpFrom string: From address to use when mailing through custom SMTP
smtpPort number: SMTP server port
smtpUsername string: SMTP server username
snapshotSharingEnabled boolean: Allow snapshot share links creation
sslRequired boolean: Is SSL required? Disabling this is insecure.
subdomain string: Site subdomain
switchToPlanDate string: If switching plans, when does the new plan take effect?
trialDaysLeft number: Number of days left in trial
trialUntil string: When does this Site trial expire?
uploadsViaEmailAuthentication boolean: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
useDedicatedIpsForSmtp boolean: If using custom SMTP, should we use dedicated IPs to deliver emails?
useProvidedModifiedAt boolean: Allow uploaders to set providedModifiedAt for uploaded files?
user string: User of current session
userLockout boolean: Will users be locked out after incorrect login attempts?
userLockoutLockPeriod number: How many hours to lock user out for failed password?
userLockoutTries number: Number of login tries within userLockoutWithin hours before users are locked out
userLockoutWithin number: Number of hours for user lockout window
userRequestsEnabled boolean: Enable User Requests feature
userRequestsNotifyAdmins boolean: Send email to site admins when a user request is received?
usernameDisplay string: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
usersCanCreateApiKeys boolean: Allow users to create their own API keys?
usersCanCreateSshKeys boolean: Allow users to create their own SSH keys?
welcomeCustomText string: Custom text send in user welcome email
welcomeEmailCc string: Include this email in welcome emails if enabled
welcomeEmailEnabled boolean: Will the welcome email be sent to new users?
welcomeEmailSubject string: Include this email subject in welcome emails if enabled
welcomeScreen string: Does the welcome screen appear?
windowsModeFtp boolean: Does FTP user Windows emulation mode?

active_sftp_host_key_id int: Id of the currently selected custom SFTP Host Key
additional_text_file_types Sequence[str]: Additional extensions that are considered text files
admin_user_id int: User ID for the main site administrator
admins_bypass_locked_subfolders bool: Allow admins to bypass the locked subfolders setting.
ai_feature_availability Any: Availability settings for AI features by user class
allow_bundle_names bool: Are manual Bundle names allowed?
allow_user_level2fa_override bool: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
allow_user_level_allowed_ip_override bool: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
allow_user_level_ssl_override bool: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
allowed2fa_method_bypass_for_ftp_sftp_dav bool: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
allowed2fa_method_email bool: Is OTP via email two factor authentication allowed?
allowed2fa_method_sms bool: Is SMS two factor authentication allowed?
allowed2fa_method_static bool: Is OTP via static codes for two factor authentication allowed?
allowed2fa_method_totp bool: Is TOTP two factor authentication allowed?
allowed2fa_method_webauthn bool: Is WebAuthn two factor authentication allowed?
allowed2fa_method_yubi bool: Is yubikey two factor authentication allowed?
allowed_countries str: Comma separated list of allowed Country codes
allowed_ips str: List of allowed IP addresses
always_mkdir_parents bool: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
as2_message_retention_days int: Number of days to retain AS2 messages (incoming and outgoing).
ask_about_overwrites bool: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
bundle_activity_notifications str: Do Bundle owners receive activity notifications?
bundle_expiration int: Site-wide Bundle expiration in days
bundle_not_found_message str: Custom error message to show when bundle is not found.
bundle_password_required bool: Do Bundles require password protection?
bundle_recipient_blacklist_domains Sequence[str]: List of email domains to disallow when entering a Bundle/Inbox recipients
bundle_recipient_blacklist_free_email_domains bool: Disallow free email domains for Bundle/Inbox recipients?
bundle_registration_notifications str: Do Bundle owners receive registration notification?
bundle_require_note bool: Do Bundles require internal notes?
bundle_require_registration bool: Do Bundles require registration?
bundle_require_share_recipient bool: Do Bundles require recipients for sharing?
bundle_send_one_time_password_to_recipient_at_registration bool: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
bundle_send_shared_receipts bool: Do Bundle creators receive receipts of invitations?
bundle_upload_receipt_notifications str: Do Bundle uploaders receive upload confirmation notifications?
bundle_watermark_attachment str: Preview watermark image applied to all bundle items.
bundle_watermark_value Any: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
bundles_default_owned_by_primary_group bool: If true, new Share Links created by a user with a primary group will default to that group as owner.
calculate_file_checksums_crc32 bool: Calculate CRC32 checksums for files?
calculate_file_checksums_md5 bool: Calculate MD5 checksums for files?
calculate_file_checksums_sha1 bool: Calculate SHA1 checksums for files?
calculate_file_checksums_sha256 bool: Calculate SHA256 checksums for files?
color2_left str: Page link and button color
color2_link str: Top bar link color
color2_text str: Page link and button color
color2_top str: Top bar background color
color2_top_text str: Top bar text color
contact_name str: Site main contact name
created_at str: Time this site was created
currency str: Preferred currency
custom_namespace bool: Is this site using a custom namespace for users?
dav_enabled bool: Is WebDAV enabled?
dav_user_root_enabled bool: Use user FTP roots also for WebDAV?
days_to_retain_backups int: Number of days to keep deleted files
default_time_zone str: Site default time zone
desktop_app bool: Is the desktop app enabled?
desktop_app_session_ip_pinning bool: Is desktop app session IP pinning enabled?
desktop_app_session_lifetime int: Desktop app session lifetime (in hours)
disable_all_ai_features bool: If true, all AI features are disabled for this site.
disable_files_certificate_generation bool: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
disable_notifications bool: Are notifications disabled?
disable_password_reset bool: Is password reset disabled?
disallowed_countries str: Comma separated list of disallowed Country codes
document_edits_in_bundle_allowed bool: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
domain str: Custom domain
domain_hsts_header bool: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domain_letsencrypt_chain str: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
email str: Main email for this site
email_footer_custom_text str: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
fedramp bool: Are FedRAMP security restrictions enabled for this site?
folder_permissions_groups_only bool: If true, permissions for this site must be bound to a group (not a user).
ftp_enabled bool: Is FTP enabled?
group_admins_can_add_users bool: Allow group admins to create users in their groups
group_admins_can_bypass_user_lifecycle_rules bool: Allow group admins to exempt users in their groups from lifecycle rules
group_admins_can_delete_users bool: Allow group admins to delete users in their groups
group_admins_can_enable_disable_users bool: Allow group admins to enable or disable users in their groups
group_admins_can_manage_group_memberships bool: Allow group admins to add or remove existing users in their groups
group_admins_can_modify_users bool: Allow group admins to modify users in their groups
group_admins_can_reset_passwords bool: Allow group admins to reset passwords for users in their groups
group_admins_can_set_user_password bool: Allow group admins to set password authentication method
hipaa bool: Is there a signed HIPAA BAA between Files.com and this site?
icon128 str: Branded icon 128x128
icon16 str: Branded icon 16x16
icon32 str: Branded icon 32x32
icon48 str: Branded icon 48x48
id int: Site Id
immutable_files_set_at str: Can files be modified?
include_password_in_welcome_email bool: Include password in emails to new users?
language str: Site default language
ldap_base_dn str: Base DN for looking up users in LDAP server
ldap_domain str: Domain name that will be appended to usernames
ldap_enabled bool: Main LDAP setting: is LDAP enabled?
ldap_group_action str: Should we sync groups from LDAP server?
ldap_group_exclusion str: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
ldap_group_inclusion str: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
ldap_host str: LDAP host
ldap_host2 str: LDAP backup host
ldap_host3 str: LDAP backup host
ldap_port int: LDAP port
ldap_secure bool: Use secure LDAP?
ldap_type str: LDAP type
ldap_user_action str: Should we sync users from LDAP server?
ldap_user_include_groups str: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
ldap_username str: Username for signing in to LDAP server.
ldap_username_field str: LDAP username field
legacy_checksums_mode bool: Use legacy checksums mode?
login_help_text str: Login help text
login_page_background_image str: Branded login page background
logo str: Branded logo
managed_site_settings Any: List of site settings managed by the parent site
max_prior_passwords int: Number of prior passwords to disallow
mcp_dcr_enabled bool: Is OAuth DCR (dynamic client registration) for MCP enabled?
migrate_remote_server_sync_to_sync bool: If true, we will migrate all remote server syncs to the new Sync model.
mobile_app bool: Is the mobile app enabled?
mobile_app_session_ip_pinning bool: Is mobile app session IP pinning enabled?
mobile_app_session_lifetime int: Mobile app session lifetime (in hours)
motd_text str: A message to show users when they connect via FTP or SFTP.
motd_use_for_ftp bool: Show message to users connecting via FTP
motd_use_for_sftp bool: Show message to users connecting via SFTP
name str: Site name
next_billing_amount str: Next billing amount
next_billing_date str: Next billing date
non_sso_groups_allowed bool: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
non_sso_users_allowed bool: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
office_integration_available bool: If true, allows users to use a document editing integration.
office_integration_type str: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
oncehub_link str: Link to scheduling a meeting with our Sales team
opt_out_global bool: Use servers in the USA only?
overdue bool: Is this site's billing overdue?
password_min_length int: Shortest password length for users
password_require_letter bool: Require a letter in passwords?
password_require_mixed bool: Require lower and upper case letters in passwords?
password_require_number bool: Require a number in passwords?
password_require_special bool: Require special characters in password?
password_require_unbreached bool: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
password_requirements_apply_to_bundles bool: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
password_validity_days int: Number of days password is valid
phone str: Site phone number
pin_all_remote_servers_to_site_region bool: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
prevent_root_permissions_for_non_site_admins bool: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
protocol_access_groups_only bool: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
reply_to_email str: Reply-to email for this site
require2fa bool: Require two-factor authentication for all users?
require2fa_exempt_all_sso_users bool: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
require2fa_stop_time str: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
require2fa_user_type str: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
require_logout_from_bundles_and_inboxes bool: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
restrict_root_folder_behaviors_to_site_admins bool: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
revoke_bundle_access_on_disable_or_delete bool: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
root_folder_behaviors_apply_to_workspaces bool: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
session str: Current session
session_expiry_minutes int: Session expiry in minutes
sftp_enabled bool: Is SFTP enabled?
sftp_finalize_partial_uploads bool: Finalize partial SFTP uploads from interrupted connections? Default: true.
sftp_host_key_type str: Sftp Host Key Type
sftp_insecure_ciphers bool: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
sftp_insecure_diffie_hellman bool: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
sftp_user_root_enabled bool: Use user FTP roots also for SFTP?
sharing_enabled bool: Allow bundle creation
show_request_access_link bool: Show request access link for users without access? Currently unused.
show_user_notifications_log_in_link bool: Show log in link in user notifications?
site_footer str: Custom site footer text for authenticated pages
site_header str: Custom site header text for authenticated pages
site_public_footer str: Custom site footer text for public pages
site_public_header str: Custom site header text for public pages
smtp_address str: SMTP server hostname or IP
smtp_authentication str: SMTP server authentication type
smtp_from str: From address to use when mailing through custom SMTP
smtp_port int: SMTP server port
smtp_username str: SMTP server username
snapshot_sharing_enabled bool: Allow snapshot share links creation
ssl_required bool: Is SSL required? Disabling this is insecure.
subdomain str: Site subdomain
switch_to_plan_date str: If switching plans, when does the new plan take effect?
trial_days_left int: Number of days left in trial
trial_until str: When does this Site trial expire?
uploads_via_email_authentication bool: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
use_dedicated_ips_for_smtp bool: If using custom SMTP, should we use dedicated IPs to deliver emails?
use_provided_modified_at bool: Allow uploaders to set providedModifiedAt for uploaded files?
user str: User of current session
user_lockout bool: Will users be locked out after incorrect login attempts?
user_lockout_lock_period int: How many hours to lock user out for failed password?
user_lockout_tries int: Number of login tries within userLockoutWithin hours before users are locked out
user_lockout_within int: Number of hours for user lockout window
user_requests_enabled bool: Enable User Requests feature
user_requests_notify_admins bool: Send email to site admins when a user request is received?
username_display str: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
users_can_create_api_keys bool: Allow users to create their own API keys?
users_can_create_ssh_keys bool: Allow users to create their own SSH keys?
welcome_custom_text str: Custom text send in user welcome email
welcome_email_cc str: Include this email in welcome emails if enabled
welcome_email_enabled bool: Will the welcome email be sent to new users?
welcome_email_subject str: Include this email subject in welcome emails if enabled
welcome_screen str: Does the welcome screen appear?
windows_mode_ftp bool: Does FTP user Windows emulation mode?

activeSftpHostKeyId Number: Id of the currently selected custom SFTP Host Key
additionalTextFileTypes List<String>: Additional extensions that are considered text files
adminUserId Number: User ID for the main site administrator
adminsBypassLockedSubfolders Boolean: Allow admins to bypass the locked subfolders setting.
aiFeatureAvailability Any: Availability settings for AI features by user class
allowBundleNames Boolean: Are manual Bundle names allowed?
allowUserLevel2faOverride Boolean: Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
allowUserLevelAllowedIpOverride Boolean: Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
allowUserLevelSslOverride Boolean: Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
allowed2faMethodBypassForFtpSftpDav Boolean: Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
allowed2faMethodEmail Boolean: Is OTP via email two factor authentication allowed?
allowed2faMethodSms Boolean: Is SMS two factor authentication allowed?
allowed2faMethodStatic Boolean: Is OTP via static codes for two factor authentication allowed?
allowed2faMethodTotp Boolean: Is TOTP two factor authentication allowed?
allowed2faMethodWebauthn Boolean: Is WebAuthn two factor authentication allowed?
allowed2faMethodYubi Boolean: Is yubikey two factor authentication allowed?
allowedCountries String: Comma separated list of allowed Country codes
allowedIps String: List of allowed IP addresses
alwaysMkdirParents Boolean: Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
as2MessageRetentionDays Number: Number of days to retain AS2 messages (incoming and outgoing).
askAboutOverwrites Boolean: If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
bundleActivityNotifications String: Do Bundle owners receive activity notifications?
bundleExpiration Number: Site-wide Bundle expiration in days
bundleNotFoundMessage String: Custom error message to show when bundle is not found.
bundlePasswordRequired Boolean: Do Bundles require password protection?
bundleRecipientBlacklistDomains List<String>: List of email domains to disallow when entering a Bundle/Inbox recipients
bundleRecipientBlacklistFreeEmailDomains Boolean: Disallow free email domains for Bundle/Inbox recipients?
bundleRegistrationNotifications String: Do Bundle owners receive registration notification?
bundleRequireNote Boolean: Do Bundles require internal notes?
bundleRequireRegistration Boolean: Do Bundles require registration?
bundleRequireShareRecipient Boolean: Do Bundles require recipients for sharing?
bundleSendOneTimePasswordToRecipientAtRegistration Boolean: If true, new Share Links must send a one-time password to the recipient when they register. Requires bundlerequiresharerecipient and cannot be enabled with bundlepassword_required.
bundleSendSharedReceipts Boolean: Do Bundle creators receive receipts of invitations?
bundleUploadReceiptNotifications String: Do Bundle uploaders receive upload confirmation notifications?
bundleWatermarkAttachment String: Preview watermark image applied to all bundle items.
bundleWatermarkValue Any: Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
bundlesDefaultOwnedByPrimaryGroup Boolean: If true, new Share Links created by a user with a primary group will default to that group as owner.
calculateFileChecksumsCrc32 Boolean: Calculate CRC32 checksums for files?
calculateFileChecksumsMd5 Boolean: Calculate MD5 checksums for files?
calculateFileChecksumsSha1 Boolean: Calculate SHA1 checksums for files?
calculateFileChecksumsSha256 Boolean: Calculate SHA256 checksums for files?
color2Left String: Page link and button color
color2Link String: Top bar link color
color2Text String: Page link and button color
color2Top String: Top bar background color
color2TopText String: Top bar text color
contactName String: Site main contact name
createdAt String: Time this site was created
currency String: Preferred currency
customNamespace Boolean: Is this site using a custom namespace for users?
davEnabled Boolean: Is WebDAV enabled?
davUserRootEnabled Boolean: Use user FTP roots also for WebDAV?
daysToRetainBackups Number: Number of days to keep deleted files
defaultTimeZone String: Site default time zone
desktopApp Boolean: Is the desktop app enabled?
desktopAppSessionIpPinning Boolean: Is desktop app session IP pinning enabled?
desktopAppSessionLifetime Number: Desktop app session lifetime (in hours)
disableAllAiFeatures Boolean: If true, all AI features are disabled for this site.
disableFilesCertificateGeneration Boolean: If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
disableNotifications Boolean: Are notifications disabled?
disablePasswordReset Boolean: Is password reset disabled?
disallowedCountries String: Comma separated list of disallowed Country codes
documentEditsInBundleAllowed Boolean: If true, allow public viewers of Bundles with full permissions to use document editing integrations.
domain String: Custom domain
domainHstsHeader Boolean: Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domainLetsencryptChain String: Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
email String: Main email for this site
emailFooterCustomText String: Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
fedramp Boolean: Are FedRAMP security restrictions enabled for this site?
folderPermissionsGroupsOnly Boolean: If true, permissions for this site must be bound to a group (not a user).
ftpEnabled Boolean: Is FTP enabled?
groupAdminsCanAddUsers Boolean: Allow group admins to create users in their groups
groupAdminsCanBypassUserLifecycleRules Boolean: Allow group admins to exempt users in their groups from lifecycle rules
groupAdminsCanDeleteUsers Boolean: Allow group admins to delete users in their groups
groupAdminsCanEnableDisableUsers Boolean: Allow group admins to enable or disable users in their groups
groupAdminsCanManageGroupMemberships Boolean: Allow group admins to add or remove existing users in their groups
groupAdminsCanModifyUsers Boolean: Allow group admins to modify users in their groups
groupAdminsCanResetPasswords Boolean: Allow group admins to reset passwords for users in their groups
groupAdminsCanSetUserPassword Boolean: Allow group admins to set password authentication method
hipaa Boolean: Is there a signed HIPAA BAA between Files.com and this site?
icon128 String: Branded icon 128x128
icon16 String: Branded icon 16x16
icon32 String: Branded icon 32x32
icon48 String: Branded icon 48x48
id Number: Site Id
immutableFilesSetAt String: Can files be modified?
includePasswordInWelcomeEmail Boolean: Include password in emails to new users?
language String: Site default language
ldapBaseDn String: Base DN for looking up users in LDAP server
ldapDomain String: Domain name that will be appended to usernames
ldapEnabled Boolean: Main LDAP setting: is LDAP enabled?
ldapGroupAction String: Should we sync groups from LDAP server?
ldapGroupExclusion String: Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
ldapGroupInclusion String: Comma or newline separated list of group names (with optional wildcards) to include when syncing.
ldapHost String: LDAP host
ldapHost2 String: LDAP backup host
ldapHost3 String: LDAP backup host
ldapPort Number: LDAP port
ldapSecure Boolean: Use secure LDAP?
ldapType String: LDAP type
ldapUserAction String: Should we sync users from LDAP server?
ldapUserIncludeGroups String: Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
ldapUsername String: Username for signing in to LDAP server.
ldapUsernameField String: LDAP username field
legacyChecksumsMode Boolean: Use legacy checksums mode?
loginHelpText String: Login help text
loginPageBackgroundImage String: Branded login page background
logo String: Branded logo
managedSiteSettings Any: List of site settings managed by the parent site
maxPriorPasswords Number: Number of prior passwords to disallow
mcpDcrEnabled Boolean: Is OAuth DCR (dynamic client registration) for MCP enabled?
migrateRemoteServerSyncToSync Boolean: If true, we will migrate all remote server syncs to the new Sync model.
mobileApp Boolean: Is the mobile app enabled?
mobileAppSessionIpPinning Boolean: Is mobile app session IP pinning enabled?
mobileAppSessionLifetime Number: Mobile app session lifetime (in hours)
motdText String: A message to show users when they connect via FTP or SFTP.
motdUseForFtp Boolean: Show message to users connecting via FTP
motdUseForSftp Boolean: Show message to users connecting via SFTP
name String: Site name
nextBillingAmount String: Next billing amount
nextBillingDate String: Next billing date
nonSsoGroupsAllowed Boolean: If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
nonSsoUsersAllowed Boolean: If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
officeIntegrationAvailable Boolean: If true, allows users to use a document editing integration.
officeIntegrationType String: Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
oncehubLink String: Link to scheduling a meeting with our Sales team
optOutGlobal Boolean: Use servers in the USA only?
overdue Boolean: Is this site's billing overdue?
passwordMinLength Number: Shortest password length for users
passwordRequireLetter Boolean: Require a letter in passwords?
passwordRequireMixed Boolean: Require lower and upper case letters in passwords?
passwordRequireNumber Boolean: Require a number in passwords?
passwordRequireSpecial Boolean: Require special characters in password?
passwordRequireUnbreached Boolean: Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
passwordRequirementsApplyToBundles Boolean: Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
passwordValidityDays Number: Number of days password is valid
phone String: Site phone number
pinAllRemoteServersToSiteRegion Boolean: If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
preventRootPermissionsForNonSiteAdmins Boolean: If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
protocolAccessGroupsOnly Boolean: If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
replyToEmail String: Reply-to email for this site
require2fa Boolean: Require two-factor authentication for all users?
require2faExemptAllSsoUsers Boolean: If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
require2faStopTime String: If set, requirement for two-factor authentication has been scheduled to end on this date-time.
require2faUserType String: What type of user is required to use two-factor authentication (when require2fa is set to true for this site)?
requireLogoutFromBundlesAndInboxes Boolean: If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
restrictRootFolderBehaviorsToSiteAdmins Boolean: If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
revokeBundleAccessOnDisableOrDelete Boolean: Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
rootFolderBehaviorsApplyToWorkspaces Boolean: If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrictrootfolderbehaviorstositeadmins to be enabled.
session String: Current session
sessionExpiryMinutes Number: Session expiry in minutes
sftpEnabled Boolean: Is SFTP enabled?
sftpFinalizePartialUploads Boolean: Finalize partial SFTP uploads from interrupted connections? Default: true.
sftpHostKeyType String: Sftp Host Key Type
sftpInsecureCiphers Boolean: If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
sftpInsecureDiffieHellman Boolean: If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftpInsecureCiphers option.
sftpUserRootEnabled Boolean: Use user FTP roots also for SFTP?
sharingEnabled Boolean: Allow bundle creation
showRequestAccessLink Boolean: Show request access link for users without access? Currently unused.
showUserNotificationsLogInLink Boolean: Show log in link in user notifications?
siteFooter String: Custom site footer text for authenticated pages
siteHeader String: Custom site header text for authenticated pages
sitePublicFooter String: Custom site footer text for public pages
sitePublicHeader String: Custom site header text for public pages
smtpAddress String: SMTP server hostname or IP
smtpAuthentication String: SMTP server authentication type
smtpFrom String: From address to use when mailing through custom SMTP
smtpPort Number: SMTP server port
smtpUsername String: SMTP server username
snapshotSharingEnabled Boolean: Allow snapshot share links creation
sslRequired Boolean: Is SSL required? Disabling this is insecure.
subdomain String: Site subdomain
switchToPlanDate String: If switching plans, when does the new plan take effect?
trialDaysLeft Number: Number of days left in trial
trialUntil String: When does this Site trial expire?
uploadsViaEmailAuthentication Boolean: Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
useDedicatedIpsForSmtp Boolean: If using custom SMTP, should we use dedicated IPs to deliver emails?
useProvidedModifiedAt Boolean: Allow uploaders to set providedModifiedAt for uploaded files?
user String: User of current session
userLockout Boolean: Will users be locked out after incorrect login attempts?
userLockoutLockPeriod Number: How many hours to lock user out for failed password?
userLockoutTries Number: Number of login tries within userLockoutWithin hours before users are locked out
userLockoutWithin Number: Number of hours for user lockout window
userRequestsEnabled Boolean: Enable User Requests feature
userRequestsNotifyAdmins Boolean: Send email to site admins when a user request is received?
usernameDisplay String: How usernames are displayed in the web UI. Can be usernameOnly, fullNameOnly, fullNameUsername, fullNameCompany, or fullNameUsernameCompany.
usersCanCreateApiKeys Boolean: Allow users to create their own API keys?
usersCanCreateSshKeys Boolean: Allow users to create their own SSH keys?
welcomeCustomText String: Custom text send in user welcome email
welcomeEmailCc String: Include this email in welcome emails if enabled
welcomeEmailEnabled Boolean: Will the welcome email be sent to new users?
welcomeEmailSubject String: Include this email subject in welcome emails if enabled
welcomeScreen String: Does the welcome screen appear?
windowsModeFtp Boolean: Does FTP user Windows emulation mode?

Package Details

Repository: filescom jschady/pulumi-filescom
License: Apache-2.0
Notes: This Pulumi package is based on the filescom Terraform Provider.

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

filescom.getSite

On this page

On this page

Example Usage

Using getSite

getSite Result

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

filescom.getSite

On this page

On this page

Example Usage

Using getSite

getSite Result

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.