-
-
Notifications
You must be signed in to change notification settings - Fork 38
cli client
github-actions[bot] edited this page Jan 28, 2026
·
1 revision
FileRise ships an OpenAPI v3 spec and a Redoc UI.
- Live UI:
https://your-host/api.php - Live spec (login required):
https://your-host/api.php?spec=1 - Offline spec:
openapi.json.distin the repo root
# from a checkout of the repo
openapi-generator-cli generate \
-i openapi.json.dist \
-g bash \
-o cli/bash-client# login to get a session cookie
curl -c cookies.txt -H "Content-Type: application/json" \
-d '{"username":"YOUR_USER","password":"YOUR_PASS"}' \
https://your-host/api/auth/auth.php
# fetch the spec using the session cookie
curl -b cookies.txt -o openapi.json \
https://your-host/api.php?spec=1
# generate a client
openapi-generator-cli generate \
-i openapi.json \
-g bash \
-o cli/bash-client- The live spec requires a valid session (same as the UI).
- For automation,
openapi.json.distis the simplest source.
Docs · Support · FileRise.net · Changelog
- Admin panel
- Admin gotchas
- Common env vars
- Environment variables full reference
- ACL and permissions
- ACL recipes
- Nginx setup
- Reverse proxy and subpath
- WebDAV
- WebDAV via curl
- WebDAV security and clients
- ONLYOFFICE
- Encryption at rest
- OIDC and SSO
- CIFS share auto metadata
- Sharing and public links
- Upload limits and PHP tuning
- Logs and diagnostics
- Backup and restore
- Upgrade and migration
- Migration checklist
- Maintenance scripts
- Performance quickstart
- Performance tuning
- Security hardening