Skip to main content

Settings

GET /settings/public​

Get public-facing settings. No authentication required. Used by the login page and browser clients to determine UI behavior.

Response

{
  "settings": {
    "app.name": "Gatwy",
    "app.logo": null,
    "health_monitor.enabled": true,
    "ssh.font_family": "monospace",
    "ssh.font_size": 14,
    "ssh.cursor_style": "block",
    "ssh.cursor_blink": true,
    "ssh.theme": "dark",
    "ssh.scrollback": 1000,
    "auth.ldap_enabled": false,
    "auth.oidc_enabled": false,
    "auth.oidc_button_label": "Sign in with SSO",
    "security.idle_timeout_minutes": 0,
    "system.insecure_key": false
  }
}

GET /settings​

Get all settings including sensitive configuration.

  • Auth required: Yes
  • Permission: settings.manage

Response

{
  "settings": {
    "app.name": "Gatwy",
    "security.max_login_attempts": 5,
    "security.lockout_duration_minutes": 30,
    "security.idle_timeout_minutes": 0,
    "security.session_lifetime_days": 30,
    "recordings.enabled": true,
    "recordings.max_size_mb": 0,
    "auth.ldap_enabled": false,
    "auth.ldap_url": "",
    "auth.ldap_bind_dn": "",
    "auth.ldap_search_base": "",
    "auth.ldap_username_attr": "sAMAccountName",
    "auth.oidc_enabled": false,
    "auth.oidc_issuer": "",
    "auth.oidc_client_id": "",
    "auth.oidc_button_label": "Sign in with SSO"
  }
}

PUT /settings​

Update one or more settings.

  • Auth required: Yes
  • Permission: settings.manage

Request body

{
  "app.name": "My Gateway",
  "security.max_login_attempts": 10,
  "security.idle_timeout_minutes": 30
}

Response

{ "success": true }