Zwall
Talk to an Engineer
Talk to an Engineer
Documentation
Docs Home › API › Settings

Settings

API: Manager settings

SharedStatus: SUPPORTED as console settings APIs; YAML remains the restart-authoritative source for many keysAudience: Manager administrator

Admin: AdminAuth() + RoleAuth("admin").

Do not treat PUT settings as a live-reload of every manager.yml key.

GET /api/v1/settings

PUT /api/v1/settings

Purpose. Aggregate settings blob (SettingsHandler).

Authentication. Admin.

Request (PUT). JSON object. API_SCHEMA_DOCUMENTATION_BLOCKED — untyped map.

Edition. SHARED.

GET /api/v1/settings/system

PUT /api/v1/settings/system

GET /api/v1/settings/security

PUT /api/v1/settings/security

GET /api/v1/settings/ebpf

PUT /api/v1/settings/ebpf

GET /api/v1/settings/notifications

PUT /api/v1/settings/notifications

POST /api/v1/settings/notifications/test

POST /api/v1/settings/notifications/cleanup

GET /api/v1/settings/event-logging

PUT /api/v1/settings/event-logging

Purpose. Console sections for system/security/eBPF/notifications/event-logging (ExtendedSettingsHandler).

Authentication. Admin.

Request/response. API_SCHEMA_DOCUMENTATION_BLOCKED — handlers read/write nested map[string]interface{} / gin.H. Notification test fires configured channels; treat credentials as secrets.

Known related YAML (authoritative for restart): notifications.email.*, notifications.webhook.*, security.* families — Manager Configuration.

Errors. 400 bind; 500 persist; 503 channel not configured on test.

Edition. SHARED.

Security. PUT must not be used to paste secrets into tickets. Enterprise production secrets stay in systemd credentials.

POST /api/v1/admin/rotate-secret

GET /api/v1/admin/secrets-status

Purpose. Historical API secret rotation / status (SettingsHandler.RotateSecret, GetSecretsStatus).

Authentication. Admin. Registered on the messenger admin group in Main when messenger handler is non-nil.

Enterprise: zwallctl secret-rotate explains that API rotation is retired; use setup.sh --manager-secret-custody rotate. Do not document argv secret rotation as the Enterprise production path.

Community: CLI still performs live API rotation — Operator Commands.

Request/response. API_SCHEMA_DOCUMENTATION_BLOCKED.

Edition. SHARED implementation; Enterprise production path is custody, not this API.