@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Files.com API
@base https://app.files.com/api/rest/v1
@version 0.0.1
@auth ApiKey X-FilesAPI-Key in header
@endpoints 341
@hint download_for_search
@toc sessions(2), action_logs(1), action_notification_exports(2), action_notification_export_results(1), api_key(3), api_keys(5), site(8), user(6), users(16), api_request_logs(1), apps(1), as2_incoming_messages(1), as2_outgoing_messages(1), as2_partners(5), as2_stations(5), automations(6), automation_logs(1), automation_runs(2), bandwidth_snapshots(1), behaviors(7), bundle_actions(1), bundle_downloads(1), bundle_notifications(5), bundle_recipients(2), bundle_registrations(1), bundles(6), child_site_management_policies(5), clickwraps(5), dns_records(1), desktop_configuration_profiles(5), email_incoming_messages(1), email_logs(1), exavault_api_request_logs(1), expectation_evaluations(2), expectation_incidents(5), expectations(6), external_events(3), files(4), file_actions(7), file_comments(4), file_comment_reactions(2), file_migrations(1), file_migration_logs(1), folders(2), form_field_sets(5), ftp_action_logs(1), groups(10), group_users(4), gpg_keys(5), history(5), history_exports(2), history_export_results(1), holiday_regions(1), inbox_recipients(2), inbox_registrations(1), inbox_uploads(1), inbound_s3_logs(1), invoices(2), ip_addresses(4), key_lifecycle_rules(5), locks(3), messages(5), message_comments(5), message_comment_reactions(4), message_reactions(4), notifications(5), outbound_connection_logs(1), partners(5), partner_sites(2), partner_site_requests(6), payments(2), permissions(3), projects(5), public_hosting_request_logs(1), public_keys(5), restores(2), remote_bandwidth_snapshots(1), remote_mount_backends(6), remote_servers(8), remote_server_credentials(5), requests(4), scim_logs(2), settings_changes(1), sftp_action_logs(1), sftp_host_keys(5), share_groups(5), siem_http_destinations(6), snapshots(6), sso_strategies(3), styles(3), syncs(7), sync_logs(1), sync_runs(2), usage_snapshots(1), usage_daily_snapshots(1), user_cipher_uses(1), user_lifecycle_rules(5), user_requests(4), user_sftp_client_uses(1), web_dav_action_logs(1), webhook_tests(1), workspaces(5)

@group sessions
@endpoint DELETE /sessions
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /sessions
@optional {username: any, password: any, otp: any, partial_session_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group action_logs
@endpoint GET /action_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group action_notification_exports
@endpoint POST /action_notification_exports
@optional {user_id: any, start_at: any, end_at: any, query_message: any, query_request_method: any, query_request_url: any, query_status: any, query_success: any, query_path: any, query_folder: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /action_notification_exports/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group action_notification_export_results
@endpoint GET /action_notification_export_results
@required {action_notification_export_id: any}
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group api_key
@endpoint DELETE /api_key
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /api_key
@optional {expires_at: any, name: any, permission_set: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /api_key
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group api_keys
@endpoint DELETE /api_keys/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /api_keys/{id}
@required {id: any}
@optional {description: any, expires_at: any, name: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /api_keys/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /api_keys
@required {name: any}
@optional {user_id: any, description: any, expires_at: any, aws_style_credentials: any, path: any, permission_set: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /api_keys
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group site
@endpoint GET /site/usage
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /site
@optional {name: any, subdomain: any, domain: any, domain_hsts_header: any, domain_letsencrypt_chain: any, email: any, reply_to_email: any, allow_bundle_names: any, bundle_expiration: any, welcome_email_enabled: any, ask_about_overwrites: any, show_request_access_link: any, always_mkdir_parents: any, welcome_email_cc: any, welcome_email_subject: any, welcome_custom_text: any, language: any, windows_mode_ftp: any, default_time_zone: any, desktop_app: any, desktop_app_session_ip_pinning: any, desktop_app_session_lifetime: any, mobile_app: any, mobile_app_session_ip_pinning: any, mobile_app_session_lifetime: any, folder_permissions_groups_only: any, welcome_screen: any, office_integration_available: any, office_integration_type: any, pin_all_remote_servers_to_site_region: any, motd_text: any, motd_use_for_ftp: any, motd_use_for_sftp: any, left_navigation_visibility: any, additional_text_file_types: any, bundle_require_note: any, bundle_send_shared_receipts: any, calculate_file_checksums_crc32: any, calculate_file_checksums_md5: any, calculate_file_checksums_sha1: any, calculate_file_checksums_sha256: any, legacy_checksums_mode: any, migrate_remote_server_sync_to_sync: any, as2_message_retention_days: any, session_expiry_minutes: any, ssl_required: any, sftp_insecure_ciphers: any, sftp_insecure_diffie_hellman: any, disable_files_certificate_generation: any, user_lockout: any, user_lockout_tries: any, user_lockout_within: any, user_lockout_lock_period: any, include_password_in_welcome_email: any, allowed_countries: any, allowed_ips: any, allow_user_level_2fa_override: any, allow_user_level_allowed_ip_override: any, allow_user_level_ssl_override: any, disallowed_countries: any, days_to_retain_backups: any, max_prior_passwords: any, password_validity_days: any, password_min_length: any, password_require_letter: any, password_require_mixed: any, password_require_special: any, password_require_number: any, password_require_unbreached: any, require_logout_from_bundles_and_inboxes: any, dav_user_root_enabled: any, sftp_user_root_enabled: any, disable_password_reset: any, immutable_files: any, bundle_not_found_message: any, bundle_password_required: any, bundle_require_registration: any, bundle_require_share_recipient: any, bundle_registration_notifications: any, bundle_activity_notifications: any, bundle_upload_receipt_notifications: any, document_edits_in_bundle_allowed: any, password_requirements_apply_to_bundles: any, prevent_root_permissions_for_non_site_admins: any, opt_out_global: any, use_provided_modified_at: any, custom_namespace: any, non_sso_groups_allowed: any, non_sso_users_allowed: any, sharing_enabled: any, snapshot_sharing_enabled: any, user_requests_enabled: any, user_requests_notify_admins: any, dav_enabled: any, ftp_enabled: any, sftp_enabled: any, sftp_finalize_partial_uploads: any, users_can_create_api_keys: any, users_can_create_ssh_keys: any, show_user_notifications_log_in_link: any, sftp_host_key_type: any, active_sftp_host_key_id: any, protocol_access_groups_only: any, revoke_bundle_access_on_disable_or_delete: any, bundle_watermark_value: any, group_admins_can_set_user_password: any, bundle_recipient_blacklist_free_email_domains: any, bundle_recipient_blacklist_domains: any, admins_bypass_locked_subfolders: any, allowed_2fa_method_sms: any, allowed_2fa_method_totp: any, allowed_2fa_method_webauthn: any, allowed_2fa_method_yubi: any, allowed_2fa_method_email: any, allowed_2fa_method_static: any, allowed_2fa_method_bypass_for_ftp_sftp_dav: any, require_2fa: any, require_2fa_user_type: any, color2_top: any, color2_left: any, color2_link: any, color2_text: any, color2_top_text: any, site_header: any, site_footer: any, site_public_header: any, site_public_footer: any, login_help_text: any, use_dedicated_ips_for_smtp: any, email_footer_custom_text: any, smtp_address: any, smtp_authentication: any, smtp_from: any, smtp_username: any, smtp_port: any, ldap_enabled: any, ldap_type: any, ldap_host: any, ldap_host_2: any, ldap_host_3: any, ldap_port: any, ldap_secure: any, ldap_username: any, ldap_username_field: any, ldap_domain: any, ldap_user_action: any, ldap_group_action: any, ldap_user_include_groups: any, ldap_group_exclusion: any, ldap_group_inclusion: any, ldap_base_dn: any, uploads_via_email_authentication: any, icon16_file: any, icon16_delete: any, icon32_file: any, icon32_delete: any, icon48_file: any, icon48_delete: any, icon128_file: any, icon128_delete: any, logo_file: any, logo_delete: any, bundle_watermark_attachment_file: any, bundle_watermark_attachment_delete: any, login_page_background_image_file: any, login_page_background_image_delete: any, disable_2fa_with_delay: any, ldap_password_change: any, ldap_password_change_confirmation: any, smtp_password: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /site
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /site/ip_addresses
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /site/dns_records
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /site/test-webhook
@required {url: any}
@optional {method: any, encoding: any, headers: any, body: any, action: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /site/api_keys
@required {name: any}
@optional {user_id: any, description: any, expires_at: any, aws_style_credentials: any, path: any, permission_set: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /site/api_keys
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group user
@endpoint PATCH /user
@optional {avatar_file: any, avatar_delete: any, change_password: any, change_password_confirmation: any, email: any, grant_permission: any, group_id: any, group_ids: any, imported_password_hash: any, password: any, password_confirmation: any, announcements_read: any, allowed_ips: any, attachments_permission: any, authenticate_until: any, authentication_method: any, billing_permission: any, bypass_user_lifecycle_rules: any, bypass_site_allowed_ips: any, dav_permission: any, desktop_configuration_profile_id: any, disabled: any, filesystem_layout: any, ftp_permission: any, header_text: any, language: any, notification_daily_send_time: any, name: any, company: any, notes: any, office_integration_enabled: any, partner_admin: any, partner_id: any, password_validity_days: any, readonly_site_admin: any, receive_admin_alerts: any, require_login_by: any, require_password_change: any, restapi_permission: any, self_managed: any, sftp_permission: any, site_admin: any, skip_welcome_screen: any, ssl_required: any, sso_strategy_id: any, subscribe_to_newsletter: any, require_2fa: any, tags: any, time_zone: any, user_root: any, user_home: any, workspace_admin: any, username: any, clear_2fa: any, convert_to_partner_user: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /user/public_keys
@required {title: any}
@optional {user_id: any, public_key: any, generate_keypair: any, generate_private_key_password: any, generate_algorithm: any, generate_length: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /user/public_keys
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /user/groups
@optional {user_id: any, cursor: any, per_page: any, group_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /user/api_keys
@required {name: any}
@optional {user_id: any, description: any, expires_at: any, aws_style_credentials: any, path: any, permission_set: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /user/api_keys
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group users
@endpoint POST /users/{id}/unlock
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /users/{id}/resend_welcome_email
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /users/{id}/2fa/reset
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /users/{id}
@required {id: any}
@optional {new_owner_id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /users/{id}
@required {id: any}
@optional {avatar_file: any, avatar_delete: any, change_password: any, change_password_confirmation: any, email: any, grant_permission: any, group_id: any, group_ids: any, imported_password_hash: any, password: any, password_confirmation: any, announcements_read: any, allowed_ips: any, attachments_permission: any, authenticate_until: any, authentication_method: any, billing_permission: any, bypass_user_lifecycle_rules: any, bypass_site_allowed_ips: any, dav_permission: any, desktop_configuration_profile_id: any, disabled: any, filesystem_layout: any, ftp_permission: any, header_text: any, language: any, notification_daily_send_time: any, name: any, company: any, notes: any, office_integration_enabled: any, partner_admin: any, partner_id: any, password_validity_days: any, readonly_site_admin: any, receive_admin_alerts: any, require_login_by: any, require_password_change: any, restapi_permission: any, self_managed: any, sftp_permission: any, site_admin: any, skip_welcome_screen: any, ssl_required: any, sso_strategy_id: any, subscribe_to_newsletter: any, require_2fa: any, tags: any, time_zone: any, user_root: any, user_home: any, workspace_admin: any, username: any, clear_2fa: any, convert_to_partner_user: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /users
@required {username: any}
@optional {avatar_file: any, avatar_delete: any, change_password: any, change_password_confirmation: any, email: any, grant_permission: any, group_id: any, group_ids: any, imported_password_hash: any, password: any, password_confirmation: any, announcements_read: any, allowed_ips: any, attachments_permission: any, authenticate_until: any, authentication_method: any, billing_permission: any, bypass_user_lifecycle_rules: any, bypass_site_allowed_ips: any, dav_permission: any, desktop_configuration_profile_id: any, disabled: any, filesystem_layout: any, ftp_permission: any, header_text: any, language: any, notification_daily_send_time: any, name: any, company: any, notes: any, office_integration_enabled: any, partner_admin: any, partner_id: any, password_validity_days: any, readonly_site_admin: any, receive_admin_alerts: any, require_login_by: any, require_password_change: any, restapi_permission: any, self_managed: any, sftp_permission: any, site_admin: any, skip_welcome_screen: any, ssl_required: any, sso_strategy_id: any, subscribe_to_newsletter: any, require_2fa: any, tags: any, time_zone: any, user_root: any, user_home: any, workspace_admin: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any, ids: any, include_parent_site_users: any, search: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{user_id}/sftp_client_uses
@required {user_id: any}
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{user_id}/cipher_uses
@required {user_id: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /users/{user_id}/public_keys
@required {user_id: any, title: any}
@optional {public_key: any, generate_keypair: any, generate_private_key_password: any, generate_algorithm: any, generate_length: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{user_id}/public_keys
@required {user_id: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{user_id}/permissions
@required {user_id: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any, path: any, include_groups: any, group_id: any, partner_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{user_id}/groups
@required {user_id: any}
@optional {cursor: any, per_page: any, group_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /users/{user_id}/api_keys
@required {user_id: any, name: any}
@optional {description: any, expires_at: any, aws_style_credentials: any, path: any, permission_set: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /users/{user_id}/api_keys
@required {user_id: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group api_request_logs
@endpoint GET /api_request_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group apps
@endpoint GET /apps
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group as2_incoming_messages
@endpoint GET /as2_incoming_messages
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group as2_outgoing_messages
@endpoint GET /as2_outgoing_messages
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group as2_partners
@endpoint DELETE /as2_partners/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /as2_partners/{id}
@required {id: any}
@optional {enable_dedicated_ips: any, http_auth_username: any, http_auth_password: any, mdn_validation_level: any, signature_validation_level: any, server_certificate: any, default_mime_type: any, additional_http_headers: any, name: any, uri: any, public_certificate: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /as2_partners/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /as2_partners
@required {as2_station_id: any, name: any, uri: any, public_certificate: any}
@optional {enable_dedicated_ips: any, http_auth_username: any, http_auth_password: any, mdn_validation_level: any, signature_validation_level: any, server_certificate: any, default_mime_type: any, additional_http_headers: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /as2_partners
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group as2_stations
@endpoint DELETE /as2_stations/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /as2_stations/{id}
@required {id: any}
@optional {name: any, public_certificate: any, private_key: any, private_key_password: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /as2_stations/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /as2_stations
@required {name: any, public_certificate: any, private_key: any}
@optional {workspace_id: any, private_key_password: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /as2_stations
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group automations
@endpoint POST /automations/{id}/manual_run
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /automations/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /automations/{id}
@required {id: any}
@optional {source: any, destinations: any, destination_replace_from: any, destination_replace_to: any, interval: any, path: any, legacy_sync_ids: any, sync_ids: any, user_ids: any, group_ids: any, schedule_days_of_week: any, schedule_times_of_day: any, schedule_time_zone: any, holiday_region: any, always_overwrite_size_matching_files: any, always_serialize_jobs: any, description: any, disabled: any, exclude_pattern: any, import_urls: any, flatten_destination_structure: any, ignore_locked_folders: any, legacy_folder_matching: any, name: any, overwrite_files: any, path_time_zone: any, retry_on_failure_interval_in_minutes: any, retry_on_failure_number_of_attempts: any, trigger: any, trigger_actions: any, value: any, recurring_day: any, automation: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /automations/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /automations
@required {automation: any}
@optional {source: any, destinations: any, destination_replace_from: any, destination_replace_to: any, interval: any, path: any, legacy_sync_ids: any, sync_ids: any, user_ids: any, group_ids: any, schedule_days_of_week: any, schedule_times_of_day: any, schedule_time_zone: any, holiday_region: any, always_overwrite_size_matching_files: any, always_serialize_jobs: any, description: any, disabled: any, exclude_pattern: any, import_urls: any, flatten_destination_structure: any, ignore_locked_folders: any, legacy_folder_matching: any, name: any, overwrite_files: any, path_time_zone: any, retry_on_failure_interval_in_minutes: any, retry_on_failure_number_of_attempts: any, trigger: any, trigger_actions: any, value: any, recurring_day: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /automations
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group automation_logs
@endpoint GET /automation_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group automation_runs
@endpoint GET /automation_runs/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /automation_runs
@required {automation_id: any}
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bandwidth_snapshots
@endpoint GET /bandwidth_snapshots
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group behaviors
@endpoint POST /behaviors/webhook/test
@required {url: any}
@optional {method: any, encoding: any, headers: any, body: any, action: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /behaviors/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /behaviors/{id}
@required {id: any}
@optional {value: any, attachment_file: any, disable_parent_folder_behavior: any, recursive: any, name: any, description: any, attachment_delete: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /behaviors/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /behaviors
@required {path: any, behavior: any}
@optional {value: any, attachment_file: any, disable_parent_folder_behavior: any, recursive: any, name: any, description: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /behaviors
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /behaviors/folders/{path}
@required {path: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any, ancestor_behaviors: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bundle_actions
@endpoint GET /bundle_actions
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bundle_downloads
@endpoint GET /bundle_downloads
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any, bundle_id: any, bundle_registration_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bundle_notifications
@endpoint DELETE /bundle_notifications/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /bundle_notifications/{id}
@required {id: any}
@optional {notify_on_registration: any, notify_on_upload: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /bundle_notifications/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /bundle_notifications
@required {bundle_id: any}
@optional {user_id: any, notify_user_id: any, notify_on_registration: any, notify_on_upload: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /bundle_notifications
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bundle_recipients
@endpoint POST /bundle_recipients
@required {bundle_id: any, recipient: any}
@optional {user_id: any, name: any, company: any, note: any, share_after_create: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /bundle_recipients
@required {bundle_id: any}
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bundle_registrations
@endpoint GET /bundle_registrations
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, bundle_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group bundles
@endpoint GET /bundles/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /bundles/{id}
@required {id: any}
@optional {paths: any, password: any, form_field_set_id: any, clickwrap_id: any, code: any, create_snapshot: any, description: any, dont_separate_submissions_by_folder: any, expires_at: any, finalize_snapshot: any, inbox_id: any, max_uses: any, note: any, path_template: any, path_template_time_zone: any, permissions: any, require_registration: any, require_share_recipient: any, send_one_time_password_to_recipient_at_registration: any, send_email_receipt_to_uploader: any, skip_company: any, start_access_on_date: any, skip_email: any, skip_name: any, workspace_id: any, user_id: any, watermark_attachment_delete: any, watermark_attachment_file: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /bundles/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /bundles
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /bundles
@required {paths: any}
@optional {user_id: any, password: any, form_field_set_id: any, create_snapshot: any, dont_separate_submissions_by_folder: any, expires_at: any, finalize_snapshot: any, max_uses: any, description: any, note: any, code: any, path_template: any, path_template_time_zone: any, permissions: any, require_registration: any, clickwrap_id: any, inbox_id: any, require_share_recipient: any, send_one_time_password_to_recipient_at_registration: any, send_email_receipt_to_uploader: any, skip_email: any, skip_name: any, skip_company: any, start_access_on_date: any, snapshot_id: any, workspace_id: any, watermark_attachment_file: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /bundles/{id}/share
@required {id: any}
@optional {to: any, note: any, recipients: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group child_site_management_policies
@endpoint DELETE /child_site_management_policies/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /child_site_management_policies/{id}
@required {id: any}
@optional {value: any, skip_child_site_ids: any, policy_type: any, name: any, description: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /child_site_management_policies/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /child_site_management_policies
@required {policy_type: any}
@optional {value: any, skip_child_site_ids: any, name: any, description: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /child_site_management_policies
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group clickwraps
@endpoint GET /clickwraps
@optional {cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /clickwraps
@optional {name: any, body: any, use_with_bundles: any, use_with_inboxes: any, use_with_users: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /clickwraps/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /clickwraps/{id}
@required {id: any}
@optional {name: any, body: any, use_with_bundles: any, use_with_inboxes: any, use_with_users: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /clickwraps/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group dns_records
@endpoint GET /dns_records
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group desktop_configuration_profiles
@endpoint DELETE /desktop_configuration_profiles/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /desktop_configuration_profiles/{id}
@required {id: any}
@optional {name: any, workspace_id: any, mount_mappings: any, use_for_all_users: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /desktop_configuration_profiles/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /desktop_configuration_profiles
@required {name: any, mount_mappings: any}
@optional {workspace_id: any, use_for_all_users: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /desktop_configuration_profiles
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group email_incoming_messages
@endpoint GET /email_incoming_messages
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group email_logs
@endpoint GET /email_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group exavault_api_request_logs
@endpoint GET /exavault_api_request_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group expectation_evaluations
@endpoint GET /expectation_evaluations/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /expectation_evaluations
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group expectation_incidents
@endpoint POST /expectation_incidents/{id}/resolve
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /expectation_incidents/{id}/snooze
@required {id: any, snoozed_until: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /expectation_incidents/{id}/acknowledge
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /expectation_incidents/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /expectation_incidents
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group expectations
@endpoint POST /expectations/{id}/trigger_evaluation
@required {id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /expectations/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /expectations/{id}
@required {id: any}
@optional {name: any, description: any, path: any, source: any, exclude_pattern: any, disabled: any, trigger: any, interval: any, recurring_day: any, schedule_days_of_week: any, schedule_times_of_day: any, schedule_time_zone: any, holiday_region: any, lookback_interval: any, late_acceptance_interval: any, inactivity_interval: any, max_open_interval: any, criteria: any, workspace_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /expectations/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /expectations
@optional {name: any, description: any, path: any, source: any, exclude_pattern: any, disabled: any, trigger: any, interval: any, recurring_day: any, schedule_days_of_week: any, schedule_times_of_day: any, schedule_time_zone: any, holiday_region: any, lookback_interval: any, late_acceptance_interval: any, inactivity_interval: any, max_open_interval: any, criteria: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /expectations
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group external_events
@endpoint POST /external_events
@required {status: any, body: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /external_events
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /external_events/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group files
@endpoint DELETE /files/{path}
@required {path: any}
@optional {recursive: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /files/{path}
@required {path: any}
@optional {custom_metadata: any, provided_mtime: any, priority_color: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /files/{path}
@required {path: any, etags[etag]: any, etags[part]: any}
@optional {action: any, length: any, mkdir_parents: any, part: any, parts: any, provided_mtime: any, ref: any, restart: any, size: any, copy_behaviors: any, structure: any, with_rename: any, buffered_upload: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /files/{path}
@required {path: any}
@optional {action: any, preview_size: any, with_previews: any, with_priority_color: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group file_actions
@endpoint GET /file_actions/metadata/{path}
@required {path: any}
@optional {preview_size: any, with_previews: any, with_priority_color: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_actions/copy/{path}
@required {path: any, destination: any}
@optional {copy_behaviors: any, structure: any, overwrite: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_actions/move/{path}
@required {path: any, destination: any}
@optional {overwrite: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_actions/unzip
@required {path: any, destination: any}
@optional {filename: any, overwrite: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /file_actions/zip_list/{path}
@required {path: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_actions/zip
@required {paths: any, destination: any}
@optional {overwrite: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_actions/begin_upload/{path}
@required {path: any}
@optional {mkdir_parents: any, part: any, parts: any, ref: any, restart: any, size: any, with_rename: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group file_comments
@endpoint DELETE /file_comments/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /file_comments/{id}
@required {id: any, body: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_comments
@required {body: any, path: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /file_comments/files/{path}
@required {path: any}
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group file_comment_reactions
@endpoint DELETE /file_comment_reactions/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /file_comment_reactions
@required {file_comment_id: any, emoji: any}
@optional {user_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group file_migrations
@endpoint GET /file_migrations/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group file_migration_logs
@endpoint GET /file_migration_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group folders
@endpoint POST /folders/{path}
@required {path: any}
@optional {mkdir_parents: any, provided_mtime: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /folders/{path}
@required {path: any}
@optional {cursor: any, per_page: any, preview_size: any, sort_by: any, search: any, search_custom_metadata_key: any, search_all: any, with_previews: any, with_priority_color: any, type: any, modified_at_datetime: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group form_field_sets
@endpoint DELETE /form_field_sets/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /form_field_sets/{id}
@required {id: any, FormFieldSets: map}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /form_field_sets/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /form_field_sets
@required {FormFieldSets: map}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /form_field_sets
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group ftp_action_logs
@endpoint GET /ftp_action_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group groups
@endpoint POST /groups/{group_id}/users
@required {group_id: any, username: any}
@optional {avatar_file: any, avatar_delete: any, change_password: any, change_password_confirmation: any, email: any, grant_permission: any, group_ids: any, imported_password_hash: any, password: any, password_confirmation: any, announcements_read: any, allowed_ips: any, attachments_permission: any, authenticate_until: any, authentication_method: any, billing_permission: any, bypass_user_lifecycle_rules: any, bypass_site_allowed_ips: any, dav_permission: any, desktop_configuration_profile_id: any, disabled: any, filesystem_layout: any, ftp_permission: any, header_text: any, language: any, notification_daily_send_time: any, name: any, company: any, notes: any, office_integration_enabled: any, partner_admin: any, partner_id: any, password_validity_days: any, readonly_site_admin: any, receive_admin_alerts: any, require_login_by: any, require_password_change: any, restapi_permission: any, self_managed: any, sftp_permission: any, site_admin: any, skip_welcome_screen: any, ssl_required: any, sso_strategy_id: any, subscribe_to_newsletter: any, require_2fa: any, tags: any, time_zone: any, user_root: any, user_home: any, workspace_admin: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /groups/{group_id}/users
@required {group_id: any}
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /groups/{group_id}/permissions
@required {group_id: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any, path: any, include_groups: any, partner_id: any, user_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /groups/{group_id}/memberships/{user_id}
@required {group_id: any, user_id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /groups/{group_id}/memberships/{user_id}
@required {group_id: any, user_id: any}
@optional {admin: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /groups/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /groups/{id}
@required {id: any}
@optional {notes: any, user_ids: any, admin_ids: any, ftp_permission: any, sftp_permission: any, dav_permission: any, restapi_permission: any, allowed_ips: any, name: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /groups/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /groups
@required {name: any}
@optional {notes: any, user_ids: any, admin_ids: any, ftp_permission: any, sftp_permission: any, dav_permission: any, restapi_permission: any, allowed_ips: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /groups
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any, ids: any, include_parent_site_groups: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group group_users
@endpoint DELETE /group_users/{id}
@required {id: any, group_id: any, user_id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /group_users/{id}
@required {id: any, group_id: any, user_id: any}
@optional {admin: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /group_users
@optional {user_id: any, cursor: any, per_page: any, group_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /group_users
@required {group_id: any, user_id: any}
@optional {admin: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group gpg_keys
@endpoint DELETE /gpg_keys/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /gpg_keys/{id}
@required {id: any}
@optional {partner_id: any, public_key: any, private_key: any, private_key_password: any, name: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /gpg_keys/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /gpg_keys
@required {name: any}
@optional {user_id: any, partner_id: any, public_key: any, private_key: any, private_key_password: any, workspace_id: any, generate_expires_at: any, generate_keypair: any, generate_full_name: any, generate_email: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /gpg_keys
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group history
@endpoint GET /history/files/{path}
@required {path: any}
@optional {start_at: any, end_at: any, display: any, cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /history/folders/{path}
@required {path: any}
@optional {start_at: any, end_at: any, display: any, cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /history/users/{user_id}
@required {user_id: any}
@optional {start_at: any, end_at: any, display: any, cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /history/login
@optional {start_at: any, end_at: any, display: any, cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /history
@optional {start_at: any, end_at: any, display: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group history_exports
@endpoint POST /history_exports
@optional {user_id: any, start_at: any, end_at: any, query_action: any, query_interface: any, query_user_id: any, query_file_id: any, query_parent_id: any, query_path: any, query_folder: any, query_src: any, query_destination: any, query_ip: any, query_username: any, query_failure_type: any, query_target_id: any, query_target_name: any, query_target_permission: any, query_target_user_id: any, query_target_username: any, query_target_platform: any, query_target_permission_set: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /history_exports/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group history_export_results
@endpoint GET /history_export_results
@required {history_export_id: any}
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group holiday_regions
@endpoint GET /holiday_regions/supported
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group inbox_recipients
@endpoint POST /inbox_recipients
@required {inbox_id: any, recipient: any}
@optional {name: any, company: any, note: any, share_after_create: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /inbox_recipients
@required {inbox_id: any}
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group inbox_registrations
@endpoint GET /inbox_registrations
@optional {cursor: any, per_page: any, folder_behavior_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group inbox_uploads
@endpoint GET /inbox_uploads
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group inbound_s3_logs
@endpoint GET /inbound_s3_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group invoices
@endpoint GET /invoices/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /invoices
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group ip_addresses
@endpoint GET /ip_addresses/smartfile-reserved
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /ip_addresses/exavault-reserved
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /ip_addresses/reserved
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /ip_addresses
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group key_lifecycle_rules
@endpoint PATCH /key_lifecycle_rules/{id}
@required {id: any}
@optional {apply_to_all_workspaces: any, key_type: any, inactivity_days: any, name: any, workspace_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /key_lifecycle_rules/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /key_lifecycle_rules/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /key_lifecycle_rules
@optional {apply_to_all_workspaces: any, key_type: any, inactivity_days: any, name: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /key_lifecycle_rules
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group locks
@endpoint DELETE /locks/{path}
@required {path: any, token: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /locks/{path}
@required {path: any}
@optional {allow_access_by_any_user: any, exclusive: any, recursive: any, timeout: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /locks/{path}
@required {path: any}
@optional {cursor: any, per_page: any, include_children: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group messages
@endpoint DELETE /messages/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /messages/{id}
@required {id: any, project_id: any, subject: any, body: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /messages/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /messages
@required {project_id: any, subject: any, body: any}
@optional {user_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /messages
@required {project_id: any}
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group message_comments
@endpoint DELETE /message_comments/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /message_comments/{id}
@required {id: any, body: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /message_comments/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /message_comments
@required {body: any}
@optional {user_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /message_comments
@required {message_id: any}
@optional {user_id: any, cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group message_comment_reactions
@endpoint DELETE /message_comment_reactions/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /message_comment_reactions/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /message_comment_reactions
@required {emoji: any}
@optional {user_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /message_comment_reactions
@required {message_comment_id: any}
@optional {user_id: any, cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group message_reactions
@endpoint DELETE /message_reactions/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /message_reactions/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /message_reactions
@required {emoji: any}
@optional {user_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /message_reactions
@required {message_id: any}
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group notifications
@endpoint DELETE /notifications/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /notifications/{id}
@required {id: any}
@optional {notify_on_copy: any, notify_on_delete: any, notify_on_download: any, notify_on_move: any, notify_on_upload: any, notify_user_actions: any, recursive: any, send_interval: any, message: any, triggering_filenames: any, triggering_group_ids: any, triggering_user_ids: any, trigger_by_share_recipients: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /notifications/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /notifications
@optional {user_id: any, notify_on_copy: any, notify_on_delete: any, notify_on_download: any, notify_on_move: any, notify_on_upload: any, notify_user_actions: any, recursive: any, send_interval: any, message: any, triggering_filenames: any, triggering_group_ids: any, triggering_user_ids: any, trigger_by_share_recipients: any, group_id: any, path: any, username: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /notifications
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any, path: any, include_ancestors: any, group_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group outbound_connection_logs
@endpoint GET /outbound_connection_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group partners
@endpoint DELETE /partners/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /partners/{id}
@required {id: any}
@optional {allow_bypassing_2fa_policies: any, allow_credential_changes: any, allow_providing_gpg_keys: any, allow_user_creation: any, notes: any, tags: any, name: any, root_folder: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /partners/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /partners
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /partners
@required {name: any, root_folder: any}
@optional {allow_bypassing_2fa_policies: any, allow_credential_changes: any, allow_providing_gpg_keys: any, allow_user_creation: any, notes: any, tags: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group partner_sites
@endpoint GET /partner_sites/linked_partner_sites
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /partner_sites
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group partner_site_requests
@endpoint POST /partner_site_requests/{id}/reject
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /partner_site_requests/{id}/approve
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /partner_site_requests/find_by_pairing_key
@required {pairing_key: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /partner_site_requests/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /partner_site_requests
@required {partner_id: any, site_url: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /partner_site_requests
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group payments
@endpoint GET /payments/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /payments
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group permissions
@endpoint DELETE /permissions/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /permissions
@required {path: any}
@optional {group_id: any, group_ids: any, permission: any, recursive: any, partner_id: any, user_id: any, username: any, group_name: any, site_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /permissions
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any, path: any, include_groups: any, group_id: any, partner_id: any, user_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group projects
@endpoint DELETE /projects/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /projects/{id}
@required {id: any, global_access: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /projects/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /projects
@required {global_access: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /projects
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group public_hosting_request_logs
@endpoint GET /public_hosting_request_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group public_keys
@endpoint DELETE /public_keys/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /public_keys/{id}
@required {id: any, title: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /public_keys/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /public_keys
@required {title: any}
@optional {user_id: any, public_key: any, generate_keypair: any, generate_private_key_password: any, generate_algorithm: any, generate_length: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /public_keys
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group restores
@endpoint POST /restores
@required {earliest_date: any}
@optional {prefix: any, restoration_type: any, restore_deleted_permissions: any, restore_in_place: any, update_timestamps: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /restores
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group remote_bandwidth_snapshots
@endpoint GET /remote_bandwidth_snapshots
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group remote_mount_backends
@endpoint POST /remote_mount_backends/{id}/reset_status
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /remote_mount_backends/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /remote_mount_backends/{id}
@required {id: any}
@optional {enabled: any, fall: any, health_check_enabled: any, health_check_type: any, interval: any, min_free_cpu: any, min_free_mem: any, priority: any, remote_path: any, rise: any, canary_file_path: any, remote_server_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /remote_mount_backends/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /remote_mount_backends
@optional {cursor: any, per_page: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /remote_mount_backends
@required {canary_file_path: any, remote_server_mount_id: any, remote_server_id: any}
@optional {enabled: any, fall: any, health_check_enabled: any, health_check_type: any, interval: any, min_free_cpu: any, min_free_mem: any, priority: any, remote_path: any, rise: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group remote_servers
@endpoint POST /remote_servers/{id}/agent_push_update
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /remote_servers/{id}/configuration_file
@required {id: any}
@optional {api_token: any, permission_set: any, root: any, hostname: any, port: any, status: any, config_version: any, private_key: any, public_key: any, server_host_key: any, subdomain: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /remote_servers/{id}/configuration_file
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /remote_servers
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /remote_servers
@optional {password: any, private_key: any, private_key_passphrase: any, reset_authentication: any, ssl_certificate: any, aws_secret_key: any, azure_blob_storage_access_key: any, azure_blob_storage_sas_token: any, azure_files_storage_access_key: any, azure_files_storage_sas_token: any, backblaze_b2_application_key: any, backblaze_b2_key_id: any, cloudflare_secret_key: any, filebase_secret_key: any, google_cloud_storage_credentials_json: any, google_cloud_storage_s3_compatible_secret_key: any, linode_secret_key: any, s3_compatible_secret_key: any, wasabi_secret_key: any, allow_relative_paths: any, aws_access_key: any, azure_blob_storage_account: any, azure_blob_storage_container: any, azure_blob_storage_dns_suffix: any, azure_blob_storage_hierarchical_namespace: any, azure_files_storage_account: any, azure_files_storage_dns_suffix: any, azure_files_storage_share_name: any, backblaze_b2_bucket: any, backblaze_b2_s3_endpoint: any, buffer_uploads: any, cloudflare_access_key: any, cloudflare_bucket: any, cloudflare_endpoint: any, description: any, dropbox_teams: any, enable_dedicated_ips: any, filebase_access_key: any, filebase_bucket: any, files_agent_permission_set: any, files_agent_root: any, files_agent_version: any, outbound_agent_id: any, google_cloud_storage_bucket: any, google_cloud_storage_project_id: any, google_cloud_storage_s3_compatible_access_key: any, hostname: any, linode_access_key: any, linode_bucket: any, linode_region: any, max_connections: any, name: any, one_drive_account_type: any, pin_to_site_region: any, port: any, upload_staging_path: any, remote_server_credential_id: any, s3_assume_role_arn: any, s3_assume_role_duration_seconds: any, s3_bucket: any, s3_compatible_access_key: any, s3_compatible_bucket: any, s3_compatible_endpoint: any, s3_compatible_region: any, s3_region: any, server_certificate: any, server_host_key: any, server_type: any, ssl: any, username: any, wasabi_access_key: any, wasabi_bucket: any, wasabi_region: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /remote_servers/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /remote_servers/{id}
@required {id: any}
@optional {password: any, private_key: any, private_key_passphrase: any, reset_authentication: any, ssl_certificate: any, aws_secret_key: any, azure_blob_storage_access_key: any, azure_blob_storage_sas_token: any, azure_files_storage_access_key: any, azure_files_storage_sas_token: any, backblaze_b2_application_key: any, backblaze_b2_key_id: any, cloudflare_secret_key: any, filebase_secret_key: any, google_cloud_storage_credentials_json: any, google_cloud_storage_s3_compatible_secret_key: any, linode_secret_key: any, s3_compatible_secret_key: any, wasabi_secret_key: any, allow_relative_paths: any, aws_access_key: any, azure_blob_storage_account: any, azure_blob_storage_container: any, azure_blob_storage_dns_suffix: any, azure_blob_storage_hierarchical_namespace: any, azure_files_storage_account: any, azure_files_storage_dns_suffix: any, azure_files_storage_share_name: any, backblaze_b2_bucket: any, backblaze_b2_s3_endpoint: any, buffer_uploads: any, cloudflare_access_key: any, cloudflare_bucket: any, cloudflare_endpoint: any, description: any, dropbox_teams: any, enable_dedicated_ips: any, filebase_access_key: any, filebase_bucket: any, files_agent_permission_set: any, files_agent_root: any, files_agent_version: any, outbound_agent_id: any, google_cloud_storage_bucket: any, google_cloud_storage_project_id: any, google_cloud_storage_s3_compatible_access_key: any, hostname: any, linode_access_key: any, linode_bucket: any, linode_region: any, max_connections: any, name: any, one_drive_account_type: any, pin_to_site_region: any, port: any, upload_staging_path: any, remote_server_credential_id: any, s3_assume_role_arn: any, s3_assume_role_duration_seconds: any, s3_bucket: any, s3_compatible_access_key: any, s3_compatible_bucket: any, s3_compatible_endpoint: any, s3_compatible_region: any, s3_region: any, server_certificate: any, server_host_key: any, server_type: any, ssl: any, username: any, wasabi_access_key: any, wasabi_bucket: any, wasabi_region: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /remote_servers/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group remote_server_credentials
@endpoint GET /remote_server_credentials
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /remote_server_credentials
@optional {name: any, description: any, server_type: any, aws_access_key: any, s3_assume_role_arn: any, s3_assume_role_duration_seconds: any, cloudflare_access_key: any, filebase_access_key: any, google_cloud_storage_s3_compatible_access_key: any, linode_access_key: any, s3_compatible_access_key: any, username: any, wasabi_access_key: any, password: any, private_key: any, private_key_passphrase: any, aws_secret_key: any, azure_blob_storage_access_key: any, azure_blob_storage_sas_token: any, azure_files_storage_access_key: any, azure_files_storage_sas_token: any, backblaze_b2_application_key: any, backblaze_b2_key_id: any, cloudflare_secret_key: any, filebase_secret_key: any, google_cloud_storage_credentials_json: any, google_cloud_storage_s3_compatible_secret_key: any, linode_secret_key: any, s3_compatible_secret_key: any, wasabi_secret_key: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /remote_server_credentials/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /remote_server_credentials/{id}
@required {id: any}
@optional {name: any, description: any, server_type: any, aws_access_key: any, s3_assume_role_arn: any, s3_assume_role_duration_seconds: any, cloudflare_access_key: any, filebase_access_key: any, google_cloud_storage_s3_compatible_access_key: any, linode_access_key: any, s3_compatible_access_key: any, username: any, wasabi_access_key: any, password: any, private_key: any, private_key_passphrase: any, aws_secret_key: any, azure_blob_storage_access_key: any, azure_blob_storage_sas_token: any, azure_files_storage_access_key: any, azure_files_storage_sas_token: any, backblaze_b2_application_key: any, backblaze_b2_key_id: any, cloudflare_secret_key: any, filebase_secret_key: any, google_cloud_storage_credentials_json: any, google_cloud_storage_s3_compatible_secret_key: any, linode_secret_key: any, s3_compatible_secret_key: any, wasabi_secret_key: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /remote_server_credentials/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group requests
@endpoint DELETE /requests/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /requests
@required {path: any, destination: any}
@optional {user_ids: any, group_ids: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /requests
@optional {cursor: any, per_page: any, sort_by: any, mine: any, path: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /requests/folders/{path}
@required {path: any}
@optional {cursor: any, per_page: any, sort_by: any, mine: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group scim_logs
@endpoint GET /scim_logs/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /scim_logs
@optional {cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group settings_changes
@endpoint GET /settings_changes
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group sftp_action_logs
@endpoint GET /sftp_action_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group sftp_host_keys
@endpoint GET /sftp_host_keys
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /sftp_host_keys
@optional {name: any, private_key: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /sftp_host_keys/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /sftp_host_keys/{id}
@required {id: any}
@optional {name: any, private_key: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /sftp_host_keys/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group share_groups
@endpoint GET /share_groups
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /share_groups
@required {name: any, members: any}
@optional {user_id: any, notes: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /share_groups/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /share_groups/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /share_groups/{id}
@required {id: any}
@optional {notes: any, name: any, members: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group siem_http_destinations
@endpoint GET /siem_http_destinations
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /siem_http_destinations
@required {destination_type: any}
@optional {name: any, additional_headers: any, sending_active: any, generic_payload_type: any, file_destination_path: any, file_format: any, file_interval_minutes: any, splunk_token: any, azure_dcr_immutable_id: any, azure_stream_name: any, azure_oauth_client_credentials_tenant_id: any, azure_oauth_client_credentials_client_id: any, azure_oauth_client_credentials_client_secret: any, qradar_username: any, qradar_password: any, solar_winds_token: any, new_relic_api_key: any, datadog_api_key: any, action_send_enabled: any, sftp_action_send_enabled: any, ftp_action_send_enabled: any, web_dav_action_send_enabled: any, sync_send_enabled: any, outbound_connection_send_enabled: any, automation_send_enabled: any, api_request_send_enabled: any, public_hosting_request_send_enabled: any, email_send_enabled: any, exavault_api_request_send_enabled: any, settings_change_send_enabled: any, destination_url: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /siem_http_destinations/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /siem_http_destinations/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /siem_http_destinations/{id}
@required {id: any}
@optional {name: any, additional_headers: any, sending_active: any, generic_payload_type: any, file_destination_path: any, file_format: any, file_interval_minutes: any, splunk_token: any, azure_dcr_immutable_id: any, azure_stream_name: any, azure_oauth_client_credentials_tenant_id: any, azure_oauth_client_credentials_client_id: any, azure_oauth_client_credentials_client_secret: any, qradar_username: any, qradar_password: any, solar_winds_token: any, new_relic_api_key: any, datadog_api_key: any, action_send_enabled: any, sftp_action_send_enabled: any, ftp_action_send_enabled: any, web_dav_action_send_enabled: any, sync_send_enabled: any, outbound_connection_send_enabled: any, automation_send_enabled: any, api_request_send_enabled: any, public_hosting_request_send_enabled: any, email_send_enabled: any, exavault_api_request_send_enabled: any, settings_change_send_enabled: any, destination_type: any, destination_url: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /siem_http_destinations/send_test_entry
@optional {siem_http_destination_id: any, destination_type: any, destination_url: any, name: any, additional_headers: any, sending_active: any, generic_payload_type: any, file_destination_path: any, file_format: any, file_interval_minutes: any, splunk_token: any, azure_dcr_immutable_id: any, azure_stream_name: any, azure_oauth_client_credentials_tenant_id: any, azure_oauth_client_credentials_client_id: any, azure_oauth_client_credentials_client_secret: any, qradar_username: any, qradar_password: any, solar_winds_token: any, new_relic_api_key: any, datadog_api_key: any, action_send_enabled: any, sftp_action_send_enabled: any, ftp_action_send_enabled: any, web_dav_action_send_enabled: any, sync_send_enabled: any, outbound_connection_send_enabled: any, automation_send_enabled: any, api_request_send_enabled: any, public_hosting_request_send_enabled: any, email_send_enabled: any, exavault_api_request_send_enabled: any, settings_change_send_enabled: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group snapshots
@endpoint POST /snapshots/{id}/finalize
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /snapshots/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /snapshots/{id}
@required {id: any}
@optional {expires_at: any, name: any, paths: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /snapshots/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /snapshots
@optional {expires_at: any, name: any, paths: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /snapshots
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group sso_strategies
@endpoint POST /sso_strategies/{id}/sync
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /sso_strategies/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /sso_strategies
@optional {cursor: any, per_page: any, sort_by: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group styles
@endpoint DELETE /styles/{path}
@required {path: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /styles/{path}
@required {path: any}
@optional {file: any, logo_click_href: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /styles/{path}
@required {path: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group syncs
@endpoint POST /syncs/{id}/dry_run
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /syncs/{id}/manual_run
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /syncs/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /syncs/{id}
@required {id: any}
@optional {delete_empty_folders: any, description: any, dest_path: any, dest_remote_server_id: any, dest_site_id: any, disabled: any, exclude_patterns: any, holiday_region: any, include_patterns: any, interval: any, keep_after_copy: any, name: any, recurring_day: any, schedule_days_of_week: any, schedule_time_zone: any, schedule_times_of_day: any, src_path: any, src_remote_server_id: any, src_site_id: any, sync_interval_minutes: any, trigger: any, trigger_file: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /syncs/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /syncs
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /syncs
@optional {delete_empty_folders: any, description: any, dest_path: any, dest_remote_server_id: any, dest_site_id: any, disabled: any, exclude_patterns: any, holiday_region: any, include_patterns: any, interval: any, keep_after_copy: any, name: any, recurring_day: any, schedule_days_of_week: any, schedule_time_zone: any, schedule_times_of_day: any, src_path: any, src_remote_server_id: any, src_site_id: any, sync_interval_minutes: any, trigger: any, trigger_file: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group sync_logs
@endpoint GET /sync_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group sync_runs
@endpoint GET /sync_runs/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /sync_runs
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group usage_snapshots
@endpoint GET /usage_snapshots
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group usage_daily_snapshots
@endpoint GET /usage_daily_snapshots
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group user_cipher_uses
@endpoint GET /user_cipher_uses
@optional {user_id: any, cursor: any, per_page: any, sort_by: any, filter: any, filter_gt: any, filter_gteq: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group user_lifecycle_rules
@endpoint PATCH /user_lifecycle_rules/{id}
@required {id: any}
@optional {action: any, apply_to_all_workspaces: any, authentication_method: any, group_ids: any, inactivity_days: any, include_site_admins: any, include_folder_admins: any, name: any, partner_tag: any, user_state: any, user_tag: any, workspace_id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /user_lifecycle_rules/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /user_lifecycle_rules/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /user_lifecycle_rules
@optional {action: any, apply_to_all_workspaces: any, authentication_method: any, group_ids: any, inactivity_days: any, include_site_admins: any, include_folder_admins: any, name: any, partner_tag: any, user_state: any, user_tag: any, workspace_id: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /user_lifecycle_rules
@optional {cursor: any, per_page: any, sort_by: any, filter: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group user_requests
@endpoint GET /user_requests
@optional {cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /user_requests
@required {name: any, email: any, details: any}
@optional {company: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint DELETE /user_requests/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /user_requests/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group user_sftp_client_uses
@endpoint GET /user_sftp_client_uses
@optional {user_id: any, cursor: any, per_page: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group web_dav_action_logs
@endpoint GET /web_dav_action_logs
@optional {cursor: any, per_page: any, filter: any, filter_gt: any, filter_gteq: any, filter_prefix: any, filter_lt: any, filter_lteq: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group webhook_tests
@endpoint POST /webhook_tests
@required {url: any}
@optional {method: any, encoding: any, headers: any, body: any, raw_body: any, file_as_body: any, file_form_field: any, action: any, use_dedicated_ips: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@group workspaces
@endpoint DELETE /workspaces/{id}
@required {id: any}
@returns(204)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint PATCH /workspaces/{id}
@required {id: any}
@optional {name: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /workspaces/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint POST /workspaces
@optional {name: any}
@returns(201)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endpoint GET /workspaces
@optional {cursor: any, per_page: any, sort_by: any, filter: any, filter_prefix: any}
@returns(200)
@errors {400, 401, 403, 404, 405, 409, 412, 422, 423, 429}

@endgroup

@end
