Sites

A Site is the place you'll come to update site settings, as well as manage site-wide API keys.

Most site settings can be set via the API.

Site Attribute Requirements

Site AttributeRequired Feature Bundle
allowed_ipsPower
domainPower
calculate_file_checksums_crc32Power
calculate_file_checksums_md5Power
calculate_file_checksums_sha1Power
calculate_file_checksums_sha256Power
custom_namespacePower
pin_all_remote_servers_to_site_regionPower
require_2faPower
sftp_insecure_ciphersPower
smtp_addressPower
smtp_authenticationPower
smtp_fromPower
smtp_usernamePower
smtp_passwordPower
smtp_portPower
byoip_in_usePremier

Show Site Settings

SDK Method

site.Get

Return Object

Site

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    "github.com/Files-com/files-sdk-go/v3/site"
)

site, err := site.Get()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Update Site Settings

SDK Method

site.Update()

Return Object

Site

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

The X-Files-Reauthentication header is required for any requests including the following parameters: email, require_2fa, require_2fa_exempt_all_sso_users, require_2fa_user_type, disable_2fa_with_delay.

SiteUpdateParams Fields

FieldDescription
Name
string
Site name
Subdomain
string
Site subdomain
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
ReplyToEmail
string
Reply-to email for this site
AllowBundleNames
boolean
Are manual Bundle names allowed?
BundleExpiration
int64
Site-wide Bundle expiration in days
WelcomeEmailEnabled
boolean
Will the welcome email be sent to new users?
AskAboutOverwrites
boolean
If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
ShowRequestAccessLink
boolean
Show request access link for users without access? Currently unused.
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.
WelcomeEmailCc
string
Include this email in welcome emails if enabled
WelcomeEmailSubject
string
Include this email subject in welcome emails if enabled
WelcomeCustomText
string
Custom text send in user welcome email
Language
string
Site default language
WindowsModeFtp
boolean
Does FTP user Windows emulation mode?
DefaultTimeZone
string
Site default time zone
DesktopApp
boolean
Is the desktop app enabled?
DesktopAppSessionIpPinning
boolean
Is desktop app session IP pinning enabled?
DesktopAppSessionLifetime
int64
Desktop app session lifetime (in hours)
MobileApp
boolean
Is the mobile app enabled?
MobileAppSessionIpPinning
boolean
Is mobile app session IP pinning enabled?
MobileAppSessionLifetime
int64
Mobile app session lifetime (in hours)
FolderPermissionsGroupsOnly
boolean
If true, permissions for this site must be bound to a group (not a user).
WelcomeScreen
string
Does the welcome screen appear?
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.
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.
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
LeftNavigationVisibility
object
Visibility settings for account navigation
DisableAllAiFeatures
boolean
If true, all AI features are disabled for this site.
AiFeatureAvailability
object
Availability settings for AI features by user class
McpDcrEnabled
boolean
Is OAuth DCR (dynamic client registration) for MCP enabled?
AdditionalTextFileTypes
array(string)
Additional extensions that are considered text files
BundleRequireNote
boolean
Do Bundles require internal notes?
BundleSendSharedReceipts
boolean
Do Bundle creators receive receipts of invitations?
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?
LegacyChecksumsMode
boolean
Use legacy checksums mode?
MigrateRemoteServerSyncToSync
boolean
If true, we will migrate all remote server syncs to the new Sync model.
As2MessageRetentionDays
int64
Number of days to retain AS2 messages (incoming and outgoing).
UsernameDisplay
string
How usernames are displayed in the web UI. Can be username_only, full_name_only, full_name_username, full_name_company, or full_name_username_company.
SessionExpiryMinutes
int64
Session expiry in minutes
SslRequired
boolean
Is SSL required? Disabling this is insecure.
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 sftp_insecure_ciphers option.
DisableFilesCertificateGeneration
boolean
If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
Fedramp
boolean
Are FedRAMP security restrictions enabled for this site?
UserLockout
boolean
Will users be locked out after incorrect login attempts?
UserLockoutTries
int64
Number of login tries within user_lockout_within hours before users are locked out
UserLockoutWithin
int64
Number of hours for user lockout window
UserLockoutLockPeriod
int64
How many hours to lock user out for failed password?
IncludePasswordInWelcomeEmail
boolean
Include password in emails to new users?
AllowedCountries
string
Comma separated list of allowed Country codes
AllowedIps
string
List of allowed IP addresses
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?
DisallowedCountries
string
Comma separated list of disallowed Country codes
DaysToRetainBackups
int64
Number of days to keep deleted files
MaxPriorPasswords
int64
Number of prior passwords to disallow
PasswordValidityDays
int64
Number of days password is valid
PasswordMinLength
int64
Shortest password length for users
PasswordRequireLetter
boolean
Require a letter in passwords?
PasswordRequireMixed
boolean
Require lower and upper case letters in passwords?
PasswordRequireSpecial
boolean
Require special characters in password?
PasswordRequireNumber
boolean
Require a number in passwords?
PasswordRequireUnbreached
boolean
Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
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.
DavUserRootEnabled
boolean
Use user FTP roots also for WebDAV?
SftpUserRootEnabled
boolean
Use user FTP roots also for SFTP?
DisablePasswordReset
boolean
Is password reset disabled?
ImmutableFiles
boolean
Are files protected from modification?
BundleNotFoundMessage
string
Custom error message to show when bundle is not found.
BundlePasswordRequired
boolean
Do Bundles require password protection?
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 bundle_require_share_recipient and cannot be enabled with bundle_password_required.
BundleRegistrationNotifications
string
Do Bundle owners receive registration notification?
BundleActivityNotifications
string
Do Bundle owners receive activity notifications?
BundleUploadReceiptNotifications
string
Do Bundle uploaders receive upload confirmation notifications?
DocumentEditsInBundleAllowed
boolean
If true, allow public viewers of Bundles with full permissions to use document editing integrations.
PasswordRequirementsApplyToBundles
boolean
Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
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.
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.
RootFolderBehaviorsApplyToWorkspaces
boolean
If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrict_root_folder_behaviors_to_site_admins to be enabled.
OptOutGlobal
boolean
Use servers in the USA only?
UseProvidedModifiedAt
boolean
Allow uploaders to set provided_modified_at for uploaded files?
CustomNamespace
boolean
Is this site using a custom namespace for users?
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.
SharingEnabled
boolean
Allow bundle creation
SnapshotSharingEnabled
boolean
Allow snapshot share links creation
UserRequestsEnabled
boolean
Enable User Requests feature
UserRequestsNotifyAdmins
boolean
Send email to site admins when a user request is received?
DavEnabled
boolean
Is WebDAV enabled?
FtpEnabled
boolean
Is FTP enabled?
SftpEnabled
boolean
Is SFTP enabled?
SftpFinalizePartialUploads
boolean
Finalize partial SFTP uploads from interrupted connections? Default: true.
UsersCanCreateApiKeys
boolean
Allow users to create their own API keys?
UsersCanCreateSshKeys
boolean
Allow users to create their own SSH keys?
ShowUserNotificationsLogInLink
boolean
Show log in link in user notifications?
SftpHostKeyType
string
Sftp Host Key Type
ActiveSftpHostKeyId
int64
Id of the currently selected custom SFTP Host Key
ActiveSftpHostKeyIds
array(int64)
Ids of the selected custom SFTP Host Keys
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.
RevokeBundleAccessOnDisableOrDelete
boolean
Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
BundleWatermarkValue
object
Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
GroupAdminsCanAddUsers
boolean
Allow group admins to create users in their groups
GroupAdminsCanManageGroupMemberships
boolean
Allow group admins to add or remove existing users in their groups
GroupAdminsCanDeleteUsers
boolean
Allow group admins to delete users in their groups
GroupAdminsCanEnableDisableUsers
boolean
Allow group admins to enable or disable users in their groups
GroupAdminsCanModifyUsers
boolean
Allow group admins to modify users in their groups
GroupAdminsCanBypassUserLifecycleRules
boolean
Allow group admins to exempt users in their groups from lifecycle rules
GroupAdminsCanResetPasswords
boolean
Allow group admins to reset passwords for users in their groups
GroupAdminsCanSetUserPassword
boolean
Allow group admins to set password authentication method
BundleRecipientBlacklistFreeEmailDomains
boolean
Disallow free email domains for Bundle/Inbox recipients?
BundleRecipientBlacklistDomains
array(string)
List of email domains to disallow when entering a Bundle/Inbox recipients
AdminsBypassLockedSubfolders
boolean
Allow admins to bypass the locked subfolders setting.
Allowed2faMethodSms
boolean
Is SMS 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?
Allowed2faMethodEmail
boolean
Is OTP via email two factor authentication allowed?
Allowed2faMethodStatic
boolean
Is OTP via static codes for two factor authentication allowed?
Allowed2faMethodBypassForFtpSftpDav
boolean
Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
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.
Require2faUserType
string
What type of user is required to use two-factor authentication (when require_2fa is set to true for this site)?
Color2Top
string
Top bar background color
Color2Left
string
Page link and button color
Color2Link
string
Top bar link color
Color2Text
string
Page link and button color
Color2TopText
string
Top bar text color
SiteHeader
string
Custom site header text for authenticated pages
SiteFooter
string
Custom site footer text for authenticated pages
SitePublicHeader
string
Custom site header text for public pages
SitePublicFooter
string
Custom site footer text for public pages
LoginHelpText
string
Login help text
UseDedicatedIpsForSmtp
boolean
If using custom SMTP, should we use dedicated IPs to deliver emails?
EmailFooterCustomText
string
Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
SmtpAddress
string
SMTP server hostname or IP
SmtpAuthentication
string
SMTP server authentication type
SmtpFrom
string
From address to use when mailing through custom SMTP
SmtpUsername
string
SMTP server username
SmtpPort
int64
SMTP server port
LdapEnabled
boolean
Main LDAP setting: is LDAP enabled?
LdapType
string
LDAP type
LdapHost
string
LDAP host
LdapHost2
string
LDAP backup host
LdapHost3
string
LDAP backup host
LdapPort
int64
LDAP port
LdapSecure
boolean
Use secure LDAP?
LdapUsername
string
Username for signing in to LDAP server.
LdapUsernameField
string
LDAP username field
LdapDomain
string
Domain name that will be appended to usernames
LdapUserAction
string
Should we sync users from LDAP server?
LdapGroupAction
string
Should we sync groups 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.
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.
LdapBaseDn
string
Base DN for looking up users in LDAP server
UploadsViaEmailAuthentication
boolean
Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
Icon16File
file
See Attaching Files to API Requests.
Icon16Delete
boolean
If true, will delete the file stored in icon16
Icon32File
file
See Attaching Files to API Requests.
Icon32Delete
boolean
If true, will delete the file stored in icon32
Icon48File
file
See Attaching Files to API Requests.
Icon48Delete
boolean
If true, will delete the file stored in icon48
Icon128File
file
See Attaching Files to API Requests.
Icon128Delete
boolean
If true, will delete the file stored in icon128
LogoFile
file
See Attaching Files to API Requests.
LogoDelete
boolean
If true, will delete the file stored in logo
BundleWatermarkAttachmentFile
file
See Attaching Files to API Requests.
BundleWatermarkAttachmentDelete
boolean
If true, will delete the file stored in bundle_watermark_attachment
LoginPageBackgroundImageFile
file
See Attaching Files to API Requests.
LoginPageBackgroundImageDelete
boolean
If true, will delete the file stored in login_page_background_image
Disable2faWithDelay
boolean
If set to true, we will begin the process of disabling 2FA on this site.
LdapPasswordChange
string
New LDAP password.
LdapPasswordChangeConfirmation
string
Confirm new LDAP password.
RedirectOldSubdomain
boolean
If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.
SmtpPassword
string
Password for SMTP server.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    "github.com/Files-com/files-sdk-go/v3/site"
)

site, err := site.Update(files_sdk.SiteUpdateParams{Name: "My Site"})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

The Site Object

Some of the methods above return a Site object. The attributes of this object are listed below.

AttributeDescription
Id
int64
Site Id
Name
string
Site name
AdditionalTextFileTypes
array(string)
Additional extensions that are considered text files
AiFeatureAvailability
object
Availability settings for AI features by user class
Allowed2faMethodSms
boolean
Is SMS 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?
Allowed2faMethodEmail
boolean
Is OTP via email two factor authentication allowed?
Allowed2faMethodStatic
boolean
Is OTP via static codes for two factor authentication allowed?
Allowed2faMethodBypassForFtpSftpDav
boolean
Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
AdminUserId
int64
User ID for the main site administrator
AdminsBypassLockedSubfolders
boolean
Allow admins to bypass the locked subfolders setting.
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?
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
int64
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?
Possible values: never, always, per_bundle_setting
BundleExpiration
int64
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?
BundlesDefaultOwnedByPrimaryGroup
boolean
If true, new Share Links created by a user with a primary group will default to that group as owner.
BundleRecipientBlacklistDomains
array(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?
Possible values: never, always, per_bundle_setting
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 bundle_require_share_recipient and cannot be enabled with bundle_password_required.
BundleRequireNote
boolean
Do Bundles require internal notes?
BundleSendSharedReceipts
boolean
Do Bundle creators receive receipts of invitations?
BundleUploadReceiptNotifications
string
Do Bundle uploaders receive upload confirmation notifications?
Possible values: never, always, per_bundle_setting
BundleWatermarkAttachment
Image
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
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?
UploadsViaEmailAuthentication
boolean
Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
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
date-time
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
int64
Number of days to keep deleted files
DocumentEditsInBundleAllowed
boolean
If true, allow public viewers of Bundles with full permissions to use document editing integrations.
DefaultTimeZone
string
Site default time zone
DesktopApp
boolean
Is the desktop app enabled?
DesktopAppSessionIpPinning
boolean
Is desktop app session IP pinning enabled?
DesktopAppSessionLifetime
int64
Desktop app session lifetime (in hours)
LegacyChecksumsMode
boolean
Use legacy checksums mode?
MigrateRemoteServerSyncToSync
boolean
If true, we will migrate all remote server syncs to the new Sync model.
McpDcrEnabled
boolean
Is OAuth DCR (dynamic client registration) for MCP enabled?
MobileApp
boolean
Is the mobile app enabled?
MobileAppSessionIpPinning
boolean
Is mobile app session IP pinning enabled?
MobileAppSessionLifetime
int64
Mobile app session lifetime (in hours)
DisallowedCountries
string
Comma separated list of disallowed Country codes
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?
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.
Possible values: default, isrg_root_x1, dst_root_ca_x3
Email
email
Main email for this site
Fedramp
boolean
Are FedRAMP security restrictions enabled for this site?
FtpEnabled
boolean
Is FTP enabled?
ReplyToEmail
email
Reply-to email for this site
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.
FolderPermissionsGroupsOnly
boolean
If true, permissions for this site must be bound to a group (not a user).
GroupAdminsCanAddUsers
boolean
Allow group admins to create users in their groups
GroupAdminsCanManageGroupMemberships
boolean
Allow group admins to add or remove existing users in their groups
GroupAdminsCanDeleteUsers
boolean
Allow group admins to delete users in their groups
GroupAdminsCanEnableDisableUsers
boolean
Allow group admins to enable or disable users in their groups
GroupAdminsCanModifyUsers
boolean
Allow group admins to modify users in their groups
GroupAdminsCanBypassUserLifecycleRules
boolean
Allow group admins to exempt users in their groups from lifecycle rules
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
Image
Branded icon 128x128
Icon16
Image
Branded icon 16x16
Icon32
Image
Branded icon 32x32
Icon48
Image
Branded icon 48x48
ImmutableFilesSetAt
date-time
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
int64
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
LoginHelpText
string
Login help text
Logo
Image
Branded logo
LoginPageBackgroundImage
Image
Branded login page background
MaxPriorPasswords
int64
Number of prior passwords to disallow
ManagedSiteSettings
object
List of site settings managed by the parent site
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
NextBillingAmount
decimal
Next billing amount
NextBillingDate
string
Next billing date
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.
Possible values: only_office, office_365, disabled
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
int64
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
int64
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.
Require2fa
boolean
Require two-factor authentication for all users?
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.
RootFolderBehaviorsApplyToWorkspaces
boolean
If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrict_root_folder_behaviors_to_site_admins to be enabled.
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
date-time
If set, requirement for two-factor authentication has been scheduled to end on this date-time.
RevokeBundleAccessOnDisableOrDelete
boolean
Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
Require2faUserType
string
What type of user is required to use two-factor authentication (when require_2fa is set to true for this site)?
Possible values: all, folder_and_site_admins, site_admins
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.
Session
Session
Current session
SftpEnabled
boolean
Is SFTP enabled?
SftpFinalizePartialUploads
boolean
Finalize partial SFTP uploads from interrupted connections? Default: true.
SftpHostKeyType
string
Sftp Host Key Type
Possible values: default, exavault, custom, smartfile
ActiveSftpHostKeyId
int64
Id of the currently selected custom SFTP Host Key
ActiveSftpHostKeyIds
array(int64)
Ids of the selected custom SFTP Host Keys
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 sftp_insecure_ciphers option.
SftpUserRootEnabled
boolean
Use user FTP roots also for SFTP?
SharingEnabled
boolean
Allow bundle creation
ShowUserNotificationsLogInLink
boolean
Show log in link in user notifications?
ShowRequestAccessLink
boolean
Show request access link for users without access? Currently unused.
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
int64
SMTP server port
SmtpUsername
string
SMTP server username
SessionExpiryMinutes
int64
Session expiry in minutes
SnapshotSharingEnabled
boolean
Allow snapshot share links creation
SslRequired
boolean
Is SSL required? Disabling this is insecure.
Subdomain
string
Site subdomain
SwitchToPlanDate
date-time
If switching plans, when does the new plan take effect?
TrialDaysLeft
int64
Number of days left in trial
TrialUntil
date-time
When does this Site trial expire?
UseDedicatedIpsForSmtp
boolean
If using custom SMTP, should we use dedicated IPs to deliver emails?
UseProvidedModifiedAt
boolean
Allow uploaders to set provided_modified_at for uploaded files?
User
User
User of current session
UserLockout
boolean
Will users be locked out after incorrect login attempts?
UserLockoutLockPeriod
int64
How many hours to lock user out for failed password?
UserLockoutTries
int64
Number of login tries within user_lockout_within hours before users are locked out
UserLockoutWithin
int64
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?
UsersCanCreateApiKeys
boolean
Allow users to create their own API keys?
UsersCanCreateSshKeys
boolean
Allow users to create their own SSH keys?
UsernameDisplay
string
How usernames are displayed in the web UI. Can be username_only, full_name_only, full_name_username, full_name_company, or full_name_username_company.
Possible values: username_only, full_name_only, full_name_username, full_name_company, full_name_username_company
WelcomeCustomText
string
Custom text send in user welcome email
EmailFooterCustomText
string
Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
WelcomeEmailCc
email
Include this email in welcome emails if enabled
WelcomeEmailSubject
string
Include this email subject in welcome emails if enabled
WelcomeEmailEnabled
boolean
Will the welcome email be sent to new users?
WelcomeScreen
string
Does the welcome screen appear?
Possible values: enabled, hidden, disabled
WindowsModeFtp
boolean
Does FTP user Windows emulation mode?