Skip to content

dashboard

The dashboard domain has 1 action. On the meta surface they are all reached through arcane_dashboard; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

ActionTitleKind
dashboard.getGet dashboard snapshotread

Get dashboard snapshot

Returns the dashboard first-paint snapshot in a single response

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_dashboard with "action": "get"
  • Individual tool: arcane_dashboard_get
  • Arcane route: GET /api/environments/{id}/dashboard
  • Operation ID: get-dashboard
  • Usage: Read-only first call for how one environment is doing (needs dashboard:read. environmentId is optional, from environment.list, defaulting to the configured environment): running/stopped/total container counts, image and volume in-use/unused counts, Arcane version info, and actionItems listing only the non-zero problems (stopped containers, pending updates of standalone containers and projects taken from stored update-check results, so run image_update.check_all first for fresh data, actionable unignored vulnerabilities, API keys expired or expiring within 14 days). includeTables defaults to true and adds up to 50 containers (newest first) and 50 images (largest first). Pass false for counters only, and leave debugAllGood unset because it forces an empty actionItems list. The snapshot is cached for about 5 seconds, so counts read right after a change may be stale. Drill down with container.list, image_update.summary or vulnerability.overview.
  • Related actions: environment.list, container.list, image_update.summary, vulnerability.overview, image_update.check_all