v4
latestSwagger 2.02026-08-0343714211.7 MBsite
Sites
Show Site Settings
Show Site Settings
get/site
Response
The Site object.
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": true
}
},
"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",
"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_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,
"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,
"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,
"disable_password_reset": true,
"domain": "my-custom-domain.com",
"domain_hsts_header": true,
"domain_letsencrypt_chain": "example",
"email": "john.doe@files.com",
"fedramp": 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",
"include_password_in_welcome_email": true,
"language": "en",
"ldap_base_dn": "example",
"ldap_domain": "mysite.com",
"ldap_enabled": true,
"ldap_group_action": "disabled",
"ldap_group_exclusion": "example",
"ldap_group_inclusion": "example",
"ldap_host": "ldap.site.com",
"ldap_host_2": "ldap2.site.com",
"ldap_host_3": "ldap3.site.com",
"ldap_port": 1,
"ldap_secure": true,
"ldap_type": "open_ldap",
"ldap_user_action": "disabled",
"ldap_user_include_groups": "example",
"ldap_username": "[ldap username]",
"ldap_username_field": "sAMAccountName",
"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
},
"sftp_enabled": true,
"sftp_finalize_partial_uploads": true,
"sftp_host_key_type": "default",
"active_sftp_host_key_id": 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_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,
"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,
"subscribe_to_newsletter": true,
"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
}