FIfiles
site
Sites

Update Site Settings

Changed on

Update Site Settings

patch/site

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/site
  • Auth
    none declared

Request body multipart/form-data

namestring

Site name

subdomainstring

Site subdomain

domainstring

Custom domain

domain_hsts_headerboolean

Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?

domain_letsencrypt_chainstring

Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.

emailstring

Main email for this site

reply_to_emailstring

Reply-to email for this site

allow_bundle_namesboolean

Are manual Bundle names allowed?

bundle_expirationinteger

Site-wide Bundle expiration in days

welcome_email_enabledboolean

Will the welcome email be sent to new users?

ask_about_overwritesboolean

If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.

show_request_access_linkboolean

Show request access link for users without access? Currently unused.

always_mkdir_parentsboolean

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.

welcome_email_ccstring

Include this email in welcome emails if enabled

welcome_email_subjectstring

Include this email subject in welcome emails if enabled

welcome_custom_textstring

Custom text send in user welcome email

languagestring

Site default language

windows_mode_ftpboolean

Does FTP user Windows emulation mode?

default_time_zonestring

Site default time zone

desktop_appboolean

Is the desktop app enabled?

desktop_app_session_ip_pinningboolean

Is desktop app session IP pinning enabled?

desktop_app_session_lifetimeinteger

Desktop app session lifetime (in hours)

mobile_appboolean

Is the mobile app enabled?

mobile_app_session_ip_pinningboolean

Is mobile app session IP pinning enabled?

mobile_app_session_lifetimeinteger

Mobile app session lifetime (in hours)

folder_permissions_groups_onlyboolean

If true, permissions for this site must be bound to a group (not a user).

welcome_screenstring

Does the welcome screen appear?

office_integration_availableboolean

If true, allows users to use a document editing integration.

office_integration_typestring

Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.

pin_all_remote_servers_to_site_regionboolean

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.

motd_textstring

A message to show users when they connect via FTP or SFTP.

motd_use_for_ftpboolean

Show message to users connecting via FTP

motd_use_for_sftpboolean

Show message to users connecting via SFTP

left_navigation_visibilityobject

Visibility settings for account navigation

disable_all_ai_featuresboolean

If true, all AI features are disabled for this site.

ai_feature_availabilityobject

Availability settings for AI features. Each feature requires the site_admins, workspace_admins, folder_admins, and all_users keys. Optional selected_group_members defaults to false; when true, members of at least one group in group_ids get access regardless of the other options. All availability options are additive: any enabled option matching the user grants access. Optional group_ids is an array of integer IDs of active groups on this site, from any workspace. Omitted or empty group_ids grants no access through selected_group_members and does not affect other options. Disabling all AI features overrides these settings.

mcp_dcr_enabledboolean

Is OAuth DCR (dynamic client registration) for MCP enabled?

additional_text_file_typesstring[]

Additional extensions that are considered text files

bundle_require_noteboolean

Do Bundles require internal notes?

bundle_send_shared_receiptsboolean

Do Bundle creators receive receipts of invitations?

bundles_default_owned_by_primary_groupboolean

If true, new Share Links created by a user with a primary group will default to that group as owner.

calculate_file_checksums_crc32boolean

Calculate CRC32 checksums for files?

calculate_file_checksums_md5boolean

Calculate MD5 checksums for files?

calculate_file_checksums_sha1boolean

Calculate SHA1 checksums for files?

calculate_file_checksums_sha256boolean

Calculate SHA256 checksums for files?

legacy_checksums_modeboolean

Use legacy checksums mode?

migrate_remote_server_sync_to_syncboolean

If true, we will migrate all remote server syncs to the new Sync model.

as2_message_retention_daysinteger

Number of days to retain AS2 messages (incoming and outgoing).

file_activity_events_enabledboolean

If true, file operations produce file_action.activity.v1 EventChannel events in all workspaces. Defaults to false; subscription filters and workspace access still control delivery.

username_displaystring

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.

integration_centric_remote_server_admin_accessstring

Administrator access to user-owned Remote Servers in every Workspace: always_visible (default), never_visible, user_choice_default_visible, or user_choice_default_personal. Forced modes override owner preferences; choice modes use the preference or their default.

session_expiry_minutesinteger

Session expiry in minutes

legacy_pairing_enabledboolean

Allow legacy app pairing in all workspaces? Disabled for new sites; existing sites remain enabled until changed. Disabling blocks new pairing exchanges without revoking existing app credentials or affecting OAuth sign-in. Site administrators can re-enable it.

ssl_requiredboolean

Is SSL required? Disabling this is insecure.

sftp_insecure_ciphersboolean

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_hellmanboolean

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.

disable_files_certificate_generationboolean

If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.

fedrampboolean

Are FedRAMP security restrictions enabled for this site?

user_lockoutboolean

Will users be locked out after incorrect login attempts?

user_lockout_triesinteger

Number of login tries within user_lockout_within hours before users are locked out

user_lockout_withininteger

Number of hours for user lockout window

user_lockout_lock_periodinteger

How many hours to lock user out for failed password?

include_password_in_welcome_emailboolean

Include password in emails to new users?

allowed_countriesstring

Comma separated list of allowed Country codes

allowed_ipsstring

List of allowed IP addresses

allow_user_level_2fa_overrideboolean

Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?

allow_user_level_allowed_ip_overrideboolean

Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?

allow_user_level_ssl_overrideboolean

Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?

enforce_parent_site_user_ip_restrictionsboolean

Require Parent Site users entering this Child Site to match its allowed IP addresses in addition to their existing IP restrictions. Applies to all Workspaces. Defaults to false.

disallowed_countriesstring

Comma separated list of disallowed Country codes

days_to_retain_backupsinteger

Number of days to keep deleted files

max_prior_passwordsinteger

Number of prior passwords to disallow

password_validity_daysinteger

Number of days password is valid

password_min_lengthinteger

Shortest password length for users

password_require_letterboolean

Require a letter in passwords?

password_require_mixedboolean

Require lower and upper case letters in passwords?

password_require_specialboolean

Require special characters in password?

password_require_numberboolean

Require a number in passwords?

password_require_unbreachedboolean

Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)

require_logout_from_bundles_and_inboxesboolean

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.

dav_user_root_enabledboolean

Use user FTP roots also for WebDAV?

sftp_user_root_enabledboolean

Use user FTP roots also for SFTP?

disable_password_resetboolean

Is password reset disabled?

immutable_filesboolean

Are files protected from modification?

bundle_not_found_messagestring

Custom error message to show when bundle is not found.

bundle_password_requiredboolean

Do Bundles require password protection?

bundle_require_registrationboolean

Do Bundles require registration?

bundle_require_share_recipientboolean

Do Bundles require recipients for sharing?

bundle_send_one_time_password_to_recipient_at_registrationboolean

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.

bundle_registration_notificationsstring

Do Bundle owners receive registration notification?

bundle_activity_notificationsstring

Do Bundle owners receive activity notifications?

bundle_upload_receipt_notificationsstring

Do Bundle uploaders receive upload confirmation notifications?

document_edits_in_bundle_allowedboolean

If true, allow public viewers of Bundles with full permissions to use document editing integrations.

password_requirements_apply_to_bundlesboolean

Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?

prevent_root_permissions_for_non_site_adminsboolean

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.

restrict_root_folder_behaviors_to_site_adminsboolean

If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.

root_folder_behaviors_apply_to_workspacesboolean

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.

opt_out_globalboolean

Use servers in the USA only?

use_provided_modified_atboolean

Allow uploaders to set provided_modified_at for uploaded files?

custom_namespaceboolean

Is this site using a custom namespace for users?

non_sso_groups_allowedboolean

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_allowedboolean

If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.

sharing_enabledboolean

Allow bundle creation

snapshot_sharing_enabledboolean

Allow snapshot share links creation

user_requests_enabledboolean

Enable User Requests feature

user_requests_notify_adminsboolean

Send email to site admins when a user request is received?

dav_enabledboolean

Is WebDAV enabled?

files_com_remote_server_enabledboolean

Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.

ftp_enabledboolean

Is FTP enabled?

s3_compatible_endpoint_enabledboolean

Is the S3-compatible endpoint enabled for all users and workspaces on this site? Defaults to true. When false, user and group S3 permissions do not allow access.

sftp_enabledboolean

Is SFTP enabled?

sftp_finalize_partial_uploadsboolean

Finalize partial SFTP uploads from interrupted connections? Default: true.

users_can_create_api_keysboolean

Allow users to create their own API keys?

users_can_create_ssh_keysboolean

Allow users to create their own SSH keys?

show_user_notifications_log_in_linkboolean

Show log in link in user notifications?

sftp_host_key_typestring

Sftp Host Key Type

active_sftp_host_key_idinteger

Id of the currently selected custom SFTP Host Key

active_sftp_host_key_idsinteger[]

Ids of the selected custom SFTP Host Keys

protocol_access_groups_onlyboolean

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.

revoke_bundle_access_on_disable_or_deleteboolean

Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.

group_admins_can_add_usersboolean

Allow group admins to create users in their groups

group_admins_can_manage_group_membershipsboolean

Allow group admins to add or remove existing users in their groups

group_admins_can_delete_usersboolean

Allow group admins to delete users in their groups

group_admins_can_enable_disable_usersboolean

Allow group admins to enable or disable users in their groups

group_admins_can_modify_usersboolean

Allow group admins to modify users in their groups

group_admins_can_bypass_user_lifecycle_rulesboolean

Allow group admins to exempt users in their groups from lifecycle rules

group_admins_can_reset_passwordsboolean

Allow group admins to reset passwords for users in their groups

group_admins_can_set_user_passwordboolean

Allow group admins to set password authentication method

child_site_folder_admins_can_see_parent_site_directoryboolean

If true, administrators on this site's Child Sites, including Folder Admins, can list this site's Default Workspace users and groups and grant them folder permissions and notifications on Child Site paths.

workspace_folder_admins_can_see_default_workspace_directoryboolean

If true, Workspace Administrators and Folder Admins in a Custom Workspace can list the Default Workspace users and groups that have permissions in that Workspace and choose them as Email Notification recipients.

bundle_recipient_blacklist_free_email_domainsboolean

Disallow free email domains for Bundle/Inbox recipients?

bundle_recipient_blacklist_domainsstring[]

List of email domains to disallow when entering a Bundle/Inbox recipients

admins_bypass_locked_subfoldersboolean

Allow admins to bypass the locked subfolders setting.

allowed_2fa_method_smsboolean

Is SMS two factor authentication allowed?

allowed_2fa_method_totpboolean

Is TOTP two factor authentication allowed?

allowed_2fa_method_webauthnboolean

Is WebAuthn two factor authentication allowed?

allowed_2fa_method_yubiboolean

Is yubikey two factor authentication allowed?

allowed_2fa_method_emailboolean

Is OTP via email two factor authentication allowed?

allowed_2fa_method_staticboolean

Is OTP via static codes for two factor authentication allowed?

allowed_2fa_method_bypass_for_ftp_sftp_davboolean

Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?

require_2faboolean

Require two-factor authentication for all users?

require_2fa_exempt_all_sso_usersboolean

If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.

require_2fa_user_typestring

What type of user is required to use two-factor authentication (when require_2fa is set to true for this site)?

color2_topstring

Top bar background color

color2_leftstring

Page link and button color

color2_linkstring

Top bar link color

color2_textstring

Page link and button color

color2_top_textstring

Top bar text color

site_headerstring

Custom site header text for authenticated pages

site_footerstring

Custom site footer text for authenticated pages

site_public_headerstring

Custom site header text for public pages

site_public_footerstring

Custom site footer text for public pages

login_help_textstring

Login help text

use_dedicated_ips_for_smtpboolean

If using custom SMTP, should we use dedicated IPs to deliver emails?

email_footer_custom_textstring

Custom footer text for system-generated emails (as Markdown). Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).

smtp_addressstring

SMTP server hostname or IP

smtp_authenticationstring

SMTP server authentication type

smtp_fromstring

From address to use when mailing through custom SMTP

smtp_usernamestring

SMTP server username

smtp_portinteger

SMTP server port

smtp_sslstring

Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.

uploads_via_email_authenticationboolean

Require email authentication, virus, and spam checks for incoming emails to Inboxes and Incoming Email Automations in every Workspace on this site?

bundle_watermark_valueobject

Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value

icon16_filestring binary
icon16_deleteboolean

If true, will delete the file stored in icon16

icon32_filestring binary
icon32_deleteboolean

If true, will delete the file stored in icon32

icon48_filestring binary
icon48_deleteboolean

If true, will delete the file stored in icon48

icon128_filestring binary
icon128_deleteboolean

If true, will delete the file stored in icon128

logo_filestring binary
logo_deleteboolean

If true, will delete the file stored in logo

bundle_watermark_attachment_filestring binary
bundle_watermark_attachment_deleteboolean

If true, will delete the file stored in bundle_watermark_attachment

login_page_background_image_filestring binary
login_page_background_image_deleteboolean

If true, will delete the file stored in login_page_background_image

disable_2fa_with_delayboolean

If set to true, we will begin the process of disabling 2FA on this site.

redirect_old_subdomainboolean

If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.

smtp_passwordstring

Password for SMTP server.

Example request

{
  "bundle_watermark_value": {
    "key": "example value"
  }
}

Response

The Site object.

idinteger

Site Id

namestring

Site name

additional_text_file_typesstring[]

Additional extensions that are considered text files

ai_feature_availabilityobject

Availability settings for AI features. Each feature requires the site_admins, workspace_admins, folder_admins, and all_users keys. Optional selected_group_members defaults to false; when true, members of at least one group in group_ids get access regardless of the other options. All availability options are additive: any enabled option matching the user grants access. Optional group_ids is an array of integer IDs of active groups on this site, from any workspace. Omitted or empty group_ids grants no access through selected_group_members and does not affect other options. Disabling all AI features overrides these settings.

allowed_2fa_method_smsboolean

Is SMS two factor authentication allowed?

allowed_2fa_method_totpboolean

Is TOTP two factor authentication allowed?

allowed_2fa_method_webauthnboolean

Is WebAuthn two factor authentication allowed?

allowed_2fa_method_yubiboolean

Is yubikey two factor authentication allowed?

allowed_2fa_method_emailboolean

Is OTP via email two factor authentication allowed?

allowed_2fa_method_staticboolean

Is OTP via static codes for two factor authentication allowed?

allowed_2fa_method_bypass_for_ftp_sftp_davboolean

Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?

admin_user_idinteger

User ID for the main site administrator

admins_bypass_locked_subfoldersboolean

Allow admins to bypass the locked subfolders setting.

allow_bundle_namesboolean

Are manual Bundle names allowed?

allow_user_level_2fa_overrideboolean

Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?

allow_user_level_allowed_ip_overrideboolean

Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?

allow_user_level_ssl_overrideboolean

Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?

allowed_countriesstring

Comma separated list of allowed Country codes

allowed_ipsstring

List of allowed IP addresses

enforce_parent_site_user_ip_restrictionsboolean

Require Parent Site users entering this Child Site to match its allowed IP addresses in addition to their existing IP restrictions. Applies to all Workspaces. Defaults to false.

always_mkdir_parentsboolean

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_daysinteger

Number of days to retain AS2 messages (incoming and outgoing).

ask_about_overwritesboolean

If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.

bundle_activity_notifications'never' | 'always' | 'per_bundle_setting'

Do Bundle owners receive activity notifications?

bundle_expirationinteger

Site-wide Bundle expiration in days

bundle_not_found_messagestring

Custom error message to show when bundle is not found.

bundle_password_requiredboolean

Do Bundles require password protection?

bundles_default_owned_by_primary_groupboolean

If true, new Share Links created by a user with a primary group will default to that group as owner.

bundle_recipient_blacklist_domainsstring[]

List of email domains to disallow when entering a Bundle/Inbox recipients

bundle_recipient_blacklist_free_email_domainsboolean

Disallow free email domains for Bundle/Inbox recipients?

bundle_registration_notifications'never' | 'always' | 'per_bundle_setting'

Do Bundle owners receive registration notification?

bundle_require_registrationboolean

Do Bundles require registration?

bundle_require_share_recipientboolean

Do Bundles require recipients for sharing?

bundle_send_one_time_password_to_recipient_at_registrationboolean

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.

bundle_require_noteboolean

Do Bundles require internal notes?

bundle_send_shared_receiptsboolean

Do Bundle creators receive receipts of invitations?

bundle_upload_receipt_notifications'never' | 'always' | 'per_bundle_setting'

Do Bundle uploaders receive upload confirmation notifications?

bundle_watermark_valueobject

Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value

calculate_file_checksums_crc32boolean

Calculate CRC32 checksums for files?

calculate_file_checksums_md5boolean

Calculate MD5 checksums for files?

calculate_file_checksums_sha1boolean

Calculate SHA1 checksums for files?

calculate_file_checksums_sha256boolean

Calculate SHA256 checksums for files?

child_site_folder_admins_can_see_parent_site_directoryboolean

If true, administrators on this site's Child Sites, including Folder Admins, can list this site's Default Workspace users and groups and grant them folder permissions and notifications on Child Site paths.

workspace_folder_admins_can_see_default_workspace_directoryboolean

If true, Workspace Administrators and Folder Admins in a Custom Workspace can list the Default Workspace users and groups that have permissions in that Workspace and choose them as Email Notification recipients.

uploads_via_email_authenticationboolean

Require email authentication, virus, and spam checks for incoming emails to Inboxes and Incoming Email Automations in every Workspace on this site?

color2_leftstring

Page link and button color

color2_linkstring

Top bar link color

color2_textstring

Page link and button color

color2_topstring

Top bar background color

color2_top_textstring

Top bar text color

contact_namestring

Site main contact name

created_atstring date-time

Time this site was created

currencystring

Preferred currency

custom_namespaceboolean

Is this site using a custom namespace for users?

dav_enabledboolean

Is WebDAV enabled?

dav_user_root_enabledboolean

Use user FTP roots also for WebDAV?

days_to_retain_backupsinteger

Number of days to keep deleted files

document_edits_in_bundle_allowedboolean

If true, allow public viewers of Bundles with full permissions to use document editing integrations.

default_time_zonestring

Site default time zone

desktop_appboolean

Is the desktop app enabled?

desktop_app_session_ip_pinningboolean

Is desktop app session IP pinning enabled?

desktop_app_session_lifetimeinteger

Desktop app session lifetime (in hours)

legacy_checksums_modeboolean

Use legacy checksums mode?

legacy_pairing_enabledboolean

Allow legacy app pairing in all workspaces? Disabled for new sites; existing sites remain enabled until changed. Disabling blocks new pairing exchanges without revoking existing app credentials or affecting OAuth sign-in. Site administrators can re-enable it.

last_pairing_atstring date-time

Time of the last completed legacy app pairing across all workspaces. Failed or incomplete attempts do not count. Read-only; empty until a pairing completes after tracking begins.

migrate_remote_server_sync_to_syncboolean

If true, we will migrate all remote server syncs to the new Sync model.

mcp_dcr_enabledboolean

Is OAuth DCR (dynamic client registration) for MCP enabled?

mobile_appboolean

Is the mobile app enabled?

mobile_app_session_ip_pinningboolean

Is mobile app session IP pinning enabled?

mobile_app_session_lifetimeinteger

Mobile app session lifetime (in hours)

disallowed_countriesstring

Comma separated list of disallowed Country codes

disable_all_ai_featuresboolean

If true, all AI features are disabled for this site.

disable_files_certificate_generationboolean

If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.

disable_notificationsboolean

Are notifications disabled?

file_activity_events_enabledboolean

If true, file operations produce file_action.activity.v1 EventChannel events in all workspaces. Defaults to false; subscription filters and workspace access still control delivery.

disable_password_resetboolean

Is password reset disabled?

domainstring

Custom domain

domain_hsts_headerboolean

Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?

domain_letsencrypt_chain'default' | 'isrg_root_x1' | 'dst_root_ca_x3'

Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.

emailstring email

Main email for this site

fedrampboolean

Are FedRAMP security restrictions enabled for this site?

files_com_remote_server_enabledboolean

Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.

ftp_enabledboolean

Is FTP enabled?

reply_to_emailstring email

Reply-to email for this site

non_sso_groups_allowedboolean

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_allowedboolean

If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.

folder_permissions_groups_onlyboolean

If true, permissions for this site must be bound to a group (not a user).

group_admins_can_add_usersboolean

Allow group admins to create users in their groups

group_admins_can_manage_group_membershipsboolean

Allow group admins to add or remove existing users in their groups

group_admins_can_delete_usersboolean

Allow group admins to delete users in their groups

group_admins_can_enable_disable_usersboolean

Allow group admins to enable or disable users in their groups

group_admins_can_modify_usersboolean

Allow group admins to modify users in their groups

group_admins_can_bypass_user_lifecycle_rulesboolean

Allow group admins to exempt users in their groups from lifecycle rules

group_admins_can_reset_passwordsboolean

Allow group admins to reset passwords for users in their groups

group_admins_can_set_user_passwordboolean

Allow group admins to set password authentication method

hipaaboolean

Is there a signed HIPAA BAA between Files.com and this site?

immutable_files_set_atstring date-time

Can files be modified?

integration_centric_remote_server_admin_access'always_visible' | 'never_visible' | 'user_choice_default_visible' | 'user_choice_default_personal'

Administrator access to user-owned Remote Servers in every Workspace: always_visible (default), never_visible, user_choice_default_visible, or user_choice_default_personal. Forced modes override owner preferences; choice modes use the preference or their default.

include_password_in_welcome_emailboolean

Include password in emails to new users?

languagestring

Site default language

login_help_textstring

Login help text

max_prior_passwordsinteger

Number of prior passwords to disallow

managed_site_settingsobject

Site settings managed by the parent site. Each key identifies a managed setting, with a null value. Non-secret effective values are returned in their own Site settings fields.

motd_textstring

A message to show users when they connect via FTP or SFTP.

motd_use_for_ftpboolean

Show message to users connecting via FTP

motd_use_for_sftpboolean

Show message to users connecting via SFTP

next_billing_amountstring decimal

Next billing amount

next_billing_datestring

Next billing date

office_integration_availableboolean

If true, allows users to use a document editing integration.

office_integration_type'only_office' | 'office_365' | 'disabled'

Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.

oncehub_linkstring

Link to scheduling a meeting with our Sales team

opt_out_globalboolean

Use servers in the USA only?

overdueboolean

Is this site's billing overdue?

password_min_lengthinteger

Shortest password length for users

password_require_letterboolean

Require a letter in passwords?

password_require_mixedboolean

Require lower and upper case letters in passwords?

password_require_numberboolean

Require a number in passwords?

password_require_specialboolean

Require special characters in password?

password_require_unbreachedboolean

Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)

password_requirements_apply_to_bundlesboolean

Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?

password_validity_daysinteger

Number of days password is valid

phonestring

Site phone number

pin_all_remote_servers_to_site_regionboolean

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_adminsboolean

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_onlyboolean

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.

require_2faboolean

Require two-factor authentication for all users?

restrict_root_folder_behaviors_to_site_adminsboolean

If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.

root_folder_behaviors_apply_to_workspacesboolean

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.

require_2fa_exempt_all_sso_usersboolean

If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.

require_2fa_stop_timestring date-time

If set, requirement for two-factor authentication has been scheduled to end on this date-time.

revoke_bundle_access_on_disable_or_deleteboolean

Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.

require_2fa_user_type'all' | 'folder_and_site_admins' | 'site_admins'

What type of user is required to use two-factor authentication (when require_2fa is set to true for this site)?

require_logout_from_bundles_and_inboxesboolean

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.

s3_compatible_endpoint_enabledboolean

Is the S3-compatible endpoint enabled for all users and workspaces on this site? Defaults to true. When false, user and group S3 permissions do not allow access.

sftp_enabledboolean

Is SFTP enabled?

sftp_finalize_partial_uploadsboolean

Finalize partial SFTP uploads from interrupted connections? Default: true.

sftp_host_key_type'default' | 'exavault' | 'custom' | 'smartfile'

Sftp Host Key Type

active_sftp_host_key_idinteger

Id of the currently selected custom SFTP Host Key

active_sftp_host_key_idsinteger[]

Ids of the selected custom SFTP Host Keys

sftp_insecure_ciphersboolean

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_hellmanboolean

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.

sftp_user_root_enabledboolean

Use user FTP roots also for SFTP?

sharing_enabledboolean

Allow bundle creation

show_user_notifications_log_in_linkboolean

Show log in link in user notifications?

show_request_access_linkboolean

Show request access link for users without access? Currently unused.

site_footerstring

Custom site footer text for authenticated pages

site_headerstring

Custom site header text for authenticated pages

site_public_footerstring

Custom site footer text for public pages

site_public_headerstring

Custom site header text for public pages

smtp_addressstring

SMTP server hostname or IP

smtp_authenticationstring

SMTP server authentication type

smtp_fromstring

From address to use when mailing through custom SMTP

smtp_portinteger

SMTP server port

smtp_ssl'if_available' | 'require' | 'require_implicit' | 'never'

Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.

smtp_usernamestring

SMTP server username

session_expiry_minutesinteger

Session expiry in minutes

snapshot_sharing_enabledboolean

Allow snapshot share links creation

ssl_requiredboolean

Is SSL required? Disabling this is insecure.

subdomainstring

Site subdomain

switch_to_plan_datestring date-time

If switching plans, when does the new plan take effect?

trial_days_leftinteger

Number of days left in trial

trial_untilstring date-time

When does this Site trial expire?

use_dedicated_ips_for_smtpboolean

If using custom SMTP, should we use dedicated IPs to deliver emails?

use_provided_modified_atboolean

Allow uploaders to set provided_modified_at for uploaded files?

user_lockoutboolean

Will users be locked out after incorrect login attempts?

user_lockout_lock_periodinteger

How many hours to lock user out for failed password?

user_lockout_triesinteger

Number of login tries within user_lockout_within hours before users are locked out

user_lockout_withininteger

Number of hours for user lockout window

user_requests_enabledboolean

Enable User Requests feature

user_requests_notify_adminsboolean

Send email to site admins when a user request is received?

users_can_create_api_keysboolean

Allow users to create their own API keys?

users_can_create_ssh_keysboolean

Allow users to create their own SSH keys?

username_display'username_only' | 'full_name_only' | 'full_name_username' | 'full_name_company' | 'full_name_username_company'

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.

welcome_custom_textstring

Custom text send in user welcome email

email_footer_custom_textstring

Custom footer text for system-generated emails (as Markdown). Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).

welcome_email_ccstring email

Include this email in welcome emails if enabled

welcome_email_subjectstring

Include this email subject in welcome emails if enabled

welcome_email_enabledboolean

Will the welcome email be sent to new users?

welcome_screen'enabled' | 'hidden' | 'disabled'

Does the welcome screen appear?

windows_mode_ftpboolean

Does FTP user Windows emulation mode?

Example response

{
  "id": 1,
  "name": "My Site",
  "additional_text_file_types": [
    "example"
  ],
  "ai_feature_availability": {
    "in_app_ai_assistant": {
      "site_admins": true,
      "workspace_admins": true,
      "folder_admins": true,
      "all_users": false,
      "selected_group_members": true,
      "group_ids": [
        1,
        2
      ]
    }
  },
  "allowed_2fa_method_sms": true,
  "allowed_2fa_method_totp": true,
  "allowed_2fa_method_webauthn": true,
  "allowed_2fa_method_yubi": true,
  "allowed_2fa_method_email": true,
  "allowed_2fa_method_static": true,
  "allowed_2fa_method_bypass_for_ftp_sftp_dav": true,
  "admin_user_id": 1,
  "allow_bundle_names": true,
  "allow_user_level_2fa_override": true,
  "allow_user_level_allowed_ip_override": true,
  "allow_user_level_ssl_override": true,
  "allowed_countries": "US,DE",
  "allowed_ips": "example",
  "enforce_parent_site_user_ip_restrictions": true,
  "as2_message_retention_days": 1,
  "ask_about_overwrites": true,
  "bundle_activity_notifications": "never",
  "bundle_expiration": 1,
  "bundle_not_found_message": "example",
  "bundle_password_required": true,
  "bundles_default_owned_by_primary_group": true,
  "bundle_recipient_blacklist_domains": [
    "example"
  ],
  "bundle_recipient_blacklist_free_email_domains": true,
  "bundle_registration_notifications": "never",
  "bundle_require_registration": true,
  "bundle_require_share_recipient": true,
  "bundle_send_one_time_password_to_recipient_at_registration": true,
  "bundle_require_note": true,
  "bundle_send_shared_receipts": true,
  "bundle_upload_receipt_notifications": "never",
  "bundle_watermark_attachment": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "bundle_watermark_value": {
    "key": "example value"
  },
  "calculate_file_checksums_crc32": true,
  "calculate_file_checksums_md5": true,
  "calculate_file_checksums_sha1": true,
  "calculate_file_checksums_sha256": true,
  "child_site_folder_admins_can_see_parent_site_directory": true,
  "workspace_folder_admins_can_see_default_workspace_directory": true,
  "uploads_via_email_authentication": true,
  "color2_left": "#0066a7",
  "color2_link": "#d34f5d",
  "color2_text": "#0066a7",
  "color2_top": "#000000",
  "color2_top_text": "#ffffff",
  "contact_name": "John Doe",
  "created_at": "2000-01-01T01:00:00Z",
  "currency": "USD",
  "custom_namespace": true,
  "dav_enabled": true,
  "days_to_retain_backups": 30,
  "default_time_zone": "Pacific Time (US & Canada)",
  "desktop_app": true,
  "desktop_app_session_ip_pinning": true,
  "desktop_app_session_lifetime": 1,
  "legacy_checksums_mode": true,
  "legacy_pairing_enabled": true,
  "last_pairing_at": "2000-01-01T01:00:00Z",
  "migrate_remote_server_sync_to_sync": true,
  "mcp_dcr_enabled": true,
  "mobile_app": true,
  "mobile_app_session_ip_pinning": true,
  "mobile_app_session_lifetime": 1,
  "disallowed_countries": "US,DE",
  "disable_all_ai_features": true,
  "disable_files_certificate_generation": true,
  "disable_notifications": true,
  "file_activity_events_enabled": true,
  "disable_password_reset": true,
  "domain": "my-custom-domain.com",
  "domain_hsts_header": true,
  "domain_letsencrypt_chain": "example",
  "email": "john.doe@files.com",
  "fedramp": true,
  "files_com_remote_server_enabled": true,
  "ftp_enabled": true,
  "reply_to_email": "jane.doe@files.com",
  "non_sso_groups_allowed": true,
  "non_sso_users_allowed": true,
  "folder_permissions_groups_only": true,
  "group_admins_can_add_users": true,
  "group_admins_can_manage_group_memberships": true,
  "group_admins_can_delete_users": true,
  "group_admins_can_enable_disable_users": true,
  "group_admins_can_modify_users": true,
  "group_admins_can_bypass_user_lifecycle_rules": true,
  "group_admins_can_reset_passwords": true,
  "group_admins_can_set_user_password": true,
  "hipaa": true,
  "icon128": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "icon16": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "icon32": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "icon48": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "immutable_files_set_at": "2000-01-01T01:00:00Z",
  "integration_centric_remote_server_admin_access": "example",
  "include_password_in_welcome_email": true,
  "language": "en",
  "login_help_text": "Login page help text.",
  "logo": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "login_page_background_image": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "max_prior_passwords": 1,
  "motd_text": "example",
  "motd_use_for_ftp": true,
  "motd_use_for_sftp": true,
  "next_billing_amount": "1.0",
  "next_billing_date": "Apr 20",
  "office_integration_available": true,
  "office_integration_type": "example",
  "oncehub_link": "https://go.oncehub.com/files",
  "opt_out_global": true,
  "overdue": true,
  "password_min_length": 1,
  "password_require_letter": true,
  "password_require_mixed": true,
  "password_require_number": true,
  "password_require_special": true,
  "password_require_unbreached": true,
  "password_requirements_apply_to_bundles": true,
  "password_validity_days": 1,
  "phone": "555-555-5555",
  "pin_all_remote_servers_to_site_region": true,
  "prevent_root_permissions_for_non_site_admins": true,
  "require_2fa": true,
  "restrict_root_folder_behaviors_to_site_admins": true,
  "root_folder_behaviors_apply_to_workspaces": true,
  "require_2fa_exempt_all_sso_users": true,
  "require_2fa_stop_time": "2000-01-01T01:00:00Z",
  "require_2fa_user_type": "`site_admins`",
  "session": {
    "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
    "language": "en",
    "read_only": true
  },
  "s3_compatible_endpoint_enabled": true,
  "sftp_enabled": true,
  "sftp_finalize_partial_uploads": true,
  "sftp_host_key_type": "default",
  "active_sftp_host_key_id": 1,
  "active_sftp_host_key_ids": [
    1
  ],
  "sharing_enabled": true,
  "show_user_notifications_log_in_link": true,
  "show_request_access_link": true,
  "site_footer": "example",
  "site_header": "example",
  "site_public_footer": "example",
  "site_public_header": "example",
  "smtp_address": "smtp.my-mail-server.com",
  "smtp_authentication": "plain",
  "smtp_from": "me@my-mail-server.com",
  "smtp_port": 25,
  "smtp_ssl": "require",
  "smtp_username": "mail",
  "session_expiry_minutes": 360,
  "snapshot_sharing_enabled": true,
  "ssl_required": true,
  "subdomain": "mysite",
  "switch_to_plan_date": "2000-01-01T01:00:00Z",
  "trial_days_left": 1,
  "trial_until": "2000-01-01T01:00:00Z",
  "use_dedicated_ips_for_smtp": true,
  "use_provided_modified_at": true,
  "user": {
    "id": 1,
    "username": "user",
    "admin_group_ids": [
      1
    ],
    "allowed_ips": "10.0.0.0/8\n127.0.0.1",
    "attachments_permission": true,
    "api_keys_count": 1,
    "authenticate_until": "2000-01-01T01:00:00Z",
    "authentication_method": "password",
    "avatar_url": "example",
    "billable": true,
    "created_at": "2000-01-01T01:00:00Z",
    "dav_permission": true,
    "disabled": true,
    "disabled_expired_or_inactive": true,
    "ai_assistant_personality_id": 1,
    "desktop_configuration_profile_id": 1,
    "integration_centric_profile_id": 1,
    "email": "john.doe@files.com",
    "filesystem_layout": "site_root",
    "first_login_at": "2000-01-01T01:00:00Z",
    "ftp_permission": true,
    "group_ids": "example",
    "header_text": "User-specific message.",
    "language": "en",
    "last_login_at": "2000-01-01T01:00:00Z",
    "last_web_login_at": "2000-01-01T01:00:00Z",
    "last_ftp_login_at": "2000-01-01T01:00:00Z",
    "last_sftp_login_at": "2000-01-01T01:00:00Z",
    "last_dav_login_at": "2000-01-01T01:00:00Z",
    "last_desktop_login_at": "2000-01-01T01:00:00Z",
    "last_restapi_login_at": "2000-01-01T01:00:00Z",
    "last_api_use_at": "2000-01-01T01:00:00Z",
    "last_active_at": "2000-01-01T01:00:00Z",
    "last_protocol_cipher": "example",
    "lockout_expires": "2000-01-01T01:00:00Z",
    "name": "John Doe",
    "company": "ACME Corp.",
    "notes": "Internal notes on this user.",
    "notification_daily_send_time": 18,
    "office_integration_enabled": true,
    "partner_admin": true,
    "partner_id": 1,
    "partner_name": "example",
    "password_set_at": "2000-01-01T01:00:00Z",
    "password_validity_days": 1,
    "primary_group_id": 1,
    "public_keys_count": 1,
    "receive_admin_alerts": true,
    "notify_on_all_site_warnings": true,
    "notify_on_all_sso_failures": true,
    "notify_on_all_user_security_events": true,
    "notify_on_all_pending_work_failures": true,
    "notify_on_all_siem_http_destination_failures": true,
    "notify_on_all_sync_failures": true,
    "notify_on_all_automation_failures": true,
    "notify_on_all_expectation_failures": true,
    "require_2fa": "always_require",
    "require_login_by": "2000-01-01T01:00:00Z",
    "active_2fa": true,
    "require_password_change": true,
    "password_expired": true,
    "responsible_group_id": 1,
    "responsible_user_id": 1,
    "readonly_site_admin": true,
    "restapi_permission": true,
    "s3_compatible_endpoint_permission": true,
    "self_managed": true,
    "sftp_permission": true,
    "site_admin": true,
    "workspace_admin": true,
    "site_id": 1,
    "workspace_id": 1,
    "default_workspace_id": 1,
    "skip_welcome_screen": true,
    "ssl_required": "always_require",
    "sso_strategy_id": 1,
    "externally_managed": true,
    "tags": "example",
    "time_zone": "Pacific Time (US & Canada)",
    "type_of_2fa": "yubi",
    "type_of_2fa_for_display": "yubi",
    "user_root": "example",
    "user_home": "example",
    "days_remaining_until_password_expire": 1,
    "password_expire_at": "2000-01-01T01:00:00Z"
  },
  "user_lockout": true,
  "user_lockout_lock_period": 1,
  "user_lockout_tries": 1,
  "user_lockout_within": 6,
  "user_requests_enabled": true,
  "user_requests_notify_admins": true,
  "users_can_create_api_keys": true,
  "users_can_create_ssh_keys": true,
  "username_display": "username_only",
  "welcome_custom_text": "Welcome to my site!",
  "email_footer_custom_text": "Copyright © %Y MyCompany Inc.",
  "welcome_email_cc": "example",
  "welcome_email_subject": "example",
  "welcome_email_enabled": true,
  "welcome_screen": "user_controlled",
  "windows_mode_ftp": true
}

Changes