Pages in Reference

Configuration

Reference Updated 29 October 2026 View as Markdown

Method	Path	What it does	Permission	Sudo
GET	`/api/config`	Get Config	`settings.read`
PUT	`/api/config`	Update Config	`security.manage`	yes
PATCH	`/api/config`	Patch Config	`settings.manage`	yes
GET	`/api/config/apps-directory`	Get Apps Directory	`settings.read`
PUT	`/api/config/apps-directory`	Update Apps Directory	`settings.manage`	yes
GET	`/api/config/backup`	Get Backup Config	`settings.read`
PUT	`/api/config/backup`	Update Backup Config	`settings.manage`	yes
GET	`/api/config/defaults`	Get Defaults	`settings.read`
GET	`/api/config/delivery`	Get Delivery Config	`settings.read`
PUT	`/api/config/delivery`	Update Delivery Config	`settings.manage`	yes
GET	`/api/config/email-api`	Get Email Api Config	`settings.read`
PUT	`/api/config/email-api`	Update Email Api Config	`settings.manage`	yes
GET	`/api/config/notifications/telegram`	Get Telegram Config	`settings.read`
PUT	`/api/config/notifications/telegram`	Update Telegram Config	`settings.manage`	yes
POST	`/api/config/notifications/telegram/chats`	List Telegram Chats	`settings.manage`
POST	`/api/config/notifications/{channel}/test`	Test Notification Channel	`apps.operate`
POST	`/api/config/reload`	Reload Config	`settings.manage`
GET	`/api/config/smtp`	Get Smtp Config	`settings.read`
PUT	`/api/config/smtp`	Update Smtp Config	`settings.manage`	yes
GET	`/api/config/ssl`	Get Ssl Config	`settings.read`
PUT	`/api/config/ssl`	Update Ssl Config	`settings.manage`	yes
GET	`/api/config/web`	Get Web Config	`settings.read`
PUT	`/api/config/web`	Update Web Config	`security.manage`	yes
GET	`/api/config/webserver`	Get Webserver	`settings.read`
PUT	`/api/config/webserver`	Update Webserver	`settings.manage`	yes

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.