Get settings required to render the web UI

Public endpoint. Returns only non-sensitive settings.

get

Responses

200

Essential settings.

application/json

objectOptional

500

Unable to get essential settings.

application/json

get/api/v1/settings_essentials

HTTPcURLJavaScriptPython

GET /api/v1/settings_essentials HTTP/1.1
Accept: */*

{
  "instance_name": "defguard",
  "main_logo_url": "/svg/logo-defguard-white.svg",
  "nav_logo_url": "/svg/defguard-nav-logo.svg",
  "openid_enabled": true,
  "webhooks_enabled": true,
  "wireguard_enabled": true,
  "worker_enabled": false
}