WebDAV API
Standard filesystem-over-HTTP protocol compatible with any WebDAV client, enabling file sync and mounting as a network drive.
Introduction
WebDAV (Web Distributed Authoring and Versioning) provides filesystem-like access to WebPal documents using any WebDAV-compatible client. This allows you to mount your WebPal documents as a network drive, use desktop sync clients, or integrate with file browsers.
Endpoint
https://YOURSERVER.webpal.net/webdav
Authentication
WebDAV uses HTTP Basic authentication with your WebPal credentials:
- Username: Your WebPal login
- Password: Your WebPal password
Security Note
Always use HTTPS when connecting to WebDAV to ensure your credentials are encrypted in transit.
Supported Operations
WebPal's WebDAV implementation supports the full range of WebDAV methods:
| Operation | HTTP Method | Description |
|---|---|---|
| List directory | PROPFIND |
Get folder contents and file properties |
| Download file | GET |
Retrieve file content |
| Upload file | PUT |
Create or update a file |
| Create folder | MKCOL |
Create a new directory |
| Delete | DELETE |
Remove a file or folder |
| Move/Rename | MOVE |
Move or rename a file/folder |
| Copy | COPY |
Duplicate a file or folder |
| Get properties | PROPFIND |
Retrieve metadata and properties |
| Set properties | PROPPATCH |
Update file/folder properties |
| Lock | LOCK |
Lock a resource for editing |
| Unlock | UNLOCK |
Release a lock on a resource |
Version Tracking
WebPal automatically manages document versions when files are uploaded via WebDAV:
- When a file with the same name already exists, WebPal creates a new version entry
- Previous content is preserved in version history
- All versions are accessible from the web interface
- Version comments can be added through the web interface after upload
Permission Enforcement
WebDAV operations respect the same permission system as the web interface:
- Read-only folders will reject write operations with
403 Forbidden - Users can only access folders and files they have permissions for
- Shared folders appear in the root directory
- System shares are accessible based on user permissions
Mounting as Network Drive
Windows
- Open File Explorer
- Right-click This PC and select Map network drive
- Enter the WebDAV URL:
https://YOURSERVER.webpal.net/webdav - Check Connect using different credentials
- Enter your WebPal username and password
- Click Finish
Windows Note
Windows requires HTTPS for WebDAV connections. If you encounter issues, ensure the WebClient service is running.
macOS
- Open Finder
- Press Cmd+K or select Go > Connect to Server
- Enter:
https://YOURSERVER.webpal.net/webdav - Click Connect
- Enter your WebPal username and password
- Click Connect
Linux (Nautilus/Files)
- Open Files (Nautilus)
- Select Other Locations
- In Connect to Server, enter:
davs://YOURSERVER.webpal.net/webdav - Enter your WebPal username and password
- Click Connect
Client Applications
Desktop Sync Clients
WebPal's WebDAV endpoint is compatible with popular sync clients:
- Cyberduck (Windows, macOS) — File transfer and sync client
- Mountain Duck (Windows, macOS) — Mounts WebDAV as network drive
- DAVx⁵ (Android) — CalDAV/CardDAV/WebDAV sync
- WebDAV Navigator (iOS) — WebDAV file browser
Command Line Tools
Access WebDAV from the command line using standard tools:
curl
# List directory
curl -X PROPFIND https://YOURSERVER.webpal.net/webdav \
-u username:password
# Download file
curl -u username:password \
https://YOURSERVER.webpal.net/webdav/document.pdf \
-o document.pdf
# Upload file
curl -u username:password \
-T localfile.pdf \
https://YOURSERVER.webpal.net/webdav/localfile.pdf
cadaver
# Interactive WebDAV client
cadaver https://YOURSERVER.webpal.net/webdav
# Commands:
ls # List files
get file.pdf # Download
put file.pdf # Upload
mkcol folder # Create folder
rm file.pdf # Delete
Limitations
Be aware of these WebDAV limitations:
- Metadata: Document title and comments must be set via the web interface
- Sharing: Document sharing is only available through the web interface or APIs
- Search: Full-text search is not available via WebDAV
- Thumbnails: Thumbnail generation happens asynchronously after upload
Troubleshooting
Connection Refused
Ensure you're using HTTPS and the correct server URL. Some clients require explicit port specification: https://YOURSERVER.webpal.net:443/webdav
Authentication Failed
Verify your username and password are correct. Some clients may require the domain to be specified separately from the username.
Slow Performance
WebDAV performance depends on network latency. For large file transfers or frequent syncing, consider using the REST API with a custom sync client.
Windows Specific Issues
If Windows fails to connect:
- Ensure the WebClient service is running:
services.msc - Check registry settings for file size limits
- Use
https://instead ofhttp://
Best Practices
- Use HTTPS exclusively for security
- Avoid editing large files directly through WebDAV; download, edit, and re-upload instead
- Close files after editing to release locks
- For automated workflows, consider the REST or XML APIs for better performance