Skip to main content
Purpose: setup/read runtime config and determine readiness state for dashboard entry.

Key Endpoints

  • GET /api/config/settings
  • PUT /api/config/settings
  • GET /api/system/init-status
  • GET /api/config/env

GET /api/config/settings

Returns persisted settings, resolved OpenClaw config, settings file path, workspace validation, runtime CLI status, and workspace bootstrap details.
Example response shape:

PUT /api/config/settings

Updates settings fields (remoteAccessMode, gateway URLs/token, workspacePath, setupCompleted).

Error patterns

  • 400 INVALID_REMOTE_ACCESS_MODE
  • 400 NON_LOOPBACK_FORBIDDEN (for non-loopback gateway URL)
  • 400 for invalid body types

GET /api/system/init-status

Returns readiness and setup checks across database, OpenClaw CLI, gateway, and workspace.
Key fields:
  • ready
  • requiresSetup
  • setupCompleted
  • access.mode (local_only or tailscale_tunnel)
  • check states/messages for database, openclaw, gateway, workspace
  • checks.workspace.bootstrap provides scaffold counts created during init

Last updated

2026-02-13