Skip to content

lt.settings

lt.settings returns the deployment’s platform settings: telemetry, claim durations, event transport, auth, AI, features, branding and version information.

const result = await lt.settings.get();

Return the platform settings.

Parameters: none.

Returns: LTApiResult<{ telemetry, escalation, events, auth, ai, features, search, branding, display, environment }>

Field Type Description
telemetry.traceUrl string | null Trace URL for the telemetry provider
escalation.claimDurations number[] Claim duration options in minutes
events.transport 'socketio' | 'nats' | 'none' Dashboard event transport (socketio by default; nats when EVENT_TRANSPORT=nats)
events.natsWsUrl string | null NATS WebSocket URL, when the NATS adapter is registered
events.reconnect { initialDelayMs, maxDelayMs, noticeAfterMs, spreadMs } Dashboard reconnect timing in ms (NATS_RECONNECT_INITIAL_MS default 1000, NATS_RECONNECT_MAX_MS default 60000, NATS_LIVE_NOTICE_AFTER_MS default 30000, NATS_RECONNECT_SPREAD_MS default 5000)
auth.sso boolean Whether SSO is configured for embedded deployments
auth.ssoLogoutUrl string | null Host logout URL used on dashboard sign out
auth.ssoKeepaliveSeconds number | null SSO keepalive interval
auth.ssoKeepaliveIdleTimeoutSeconds number | null SSO keepalive idle timeout
auth.oauthServer boolean Whether the MCP OAuth authorization server is enabled
ai.enabled boolean Whether an LLM API key is configured
features object Feature flags
search object Search configuration
branding object Branding; branding.appName is the product name in the dashboard header (default "LongTail")
display object Display configuration
environment { longTailVersion, hotmeshVersion, nodeEnv, nodeVersion, eventTransport } Runtime versions and the active event transport

Auth: Not required.