action files_get_remote_servers { label: "List Remote Servers" description: "List Remote Servers" provider: files method: GET path: "/remote_servers" encoding: json input: { type: "object" properties: { cursor: { type: "string" } per_page: { type: "integer" format: "int32" } } additionalProperties: false } output: { type: "array" items: { type: "object" description: "Create Remote Server" properties: { auth_account_name: { type: "string" description: "Describes the authorized account" } auth_setup_link: { type: "string" description: "Returns link to login with an Oauth provider" } auth_status: { type: "string" description: "Either `in_setup` or `complete`" enum: ["not_applicable", "in_setup", "complete", "reauthenticate"] } authentication_method: { type: "string" description: "Type of authentication method" } aws_access_key: { type: "string" description: "AWS Access Key." } azure_blob_storage_account: { type: "string" description: "Azure Blob Storage Account name" } azure_blob_storage_container: { type: "string" description: "Azure Blob Storage Container name" } azure_blob_storage_sas_token: { type: "string" description: "Shared Access Signature (SAS) token" } azure_files_storage_account: { type: "string" description: "Azure File Storage Account name" } azure_files_storage_sas_token: { type: "string" description: "Shared Access Signature (SAS) token" } azure_files_storage_share_name: { type: "string" description: "Azure File Storage Share name" } backblaze_b2_bucket: { type: "string" description: "Backblaze B2 Cloud Storage Bucket name" } backblaze_b2_s3_endpoint: { type: "string" description: "Backblaze B2 Cloud Storage S3 Endpoint" } disabled: { type: "boolean" description: "If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag." } enable_dedicated_ips: { type: "boolean" description: "`true` if remote server only accepts connections from dedicated IPs" } filebase_access_key: { type: "string" description: "Filebase Access Key." } filebase_bucket: { type: "string" description: "Filebase Bucket name" } files_agent_api_token: { type: "string" description: "Files Agent API Token" } files_agent_permission_set: { type: "string" description: "Local permissions for files agent. read_only, write_only, or read_write" enum: ["read_write", "read_only", "write_only"] } files_agent_root: { type: "string" description: "Agent local root path" } google_cloud_storage_bucket: { type: "string" description: "Google Cloud Storage bucket name" } google_cloud_storage_project_id: { type: "string" description: "Google Cloud Project ID" } hostname: { type: "string" description: "Hostname or IP address" } id: { type: "integer" format: "int32" description: "Remote server ID" } max_connections: { type: "integer" format: "int32" description: "Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible)." } name: { type: "string" description: "Internal name for your reference" } one_drive_account_type: { type: "string" description: "Either personal or business_other account types" enum: ["personal", "business_other"] } pin_to_site_region: { type: "boolean" description: "If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a sitewide setting which will force it to true." } pinned_region: { type: "string" description: "If set, all communciations with this remote server are made through the provided region." } port: { type: "integer" format: "int32" description: "Port for remote server. Not needed for S3." } rackspace_container: { type: "string" description: "The name of the container (top level directory) where files will sync." } rackspace_region: { type: "string" description: "Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/" } rackspace_username: { type: "string" description: "Rackspace username used to login to the Rackspace Cloud Control Panel." } remote_home_path: { type: "string" description: "Initial home folder on remote server" } s3_bucket: { type: "string" description: "S3 bucket name" } s3_compatible_access_key: { type: "string" description: "S3-compatible Access Key." } s3_compatible_bucket: { type: "string" description: "S3-compatible Bucket name" } s3_compatible_endpoint: { type: "string" description: "S3-compatible endpoint" } s3_compatible_region: { type: "string" description: "S3-compatible endpoint" } s3_region: { type: "string" description: "S3 region" } server_certificate: { type: "string" description: "Remote server certificate" enum: ["require_match", "allow_any"] } server_host_key: { type: "string" description: "Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts" } server_type: { type: "string" description: "Remote server type." enum: ["ftp", "sftp", "s3", "google_cloud_storage", "webdav", "wasabi", "backblaze_b2", "one_drive", "rackspace", "box", "dropbox", "google_drive", "azure", "sharepoint", "s3_compatible", "azure_files", "files_agent", "filebase"] } ssl: { type: "string" description: "Should we require SSL?" enum: ["if_available", "require", "require_implicit", "never"] } username: { type: "string" description: "Remote server username. Not needed for S3 buckets." } wasabi_access_key: { type: "string" description: "Wasabi access key." } wasabi_bucket: { type: "string" description: "Wasabi Bucket name" } wasabi_region: { type: "string" description: "Wasabi region" } } } } }