NFLTR›Docs›Guides

Dashboard API Cookbook

The nfltr.xyz/dashboard admin views (agents, settings, fleet tokens) sit behind an authenticated session, the same as any other admin console. This cookbook scripts that session with curl so CI jobs and internal tooling can read the same data the dashboard renders — no browser required.

Mint a session from an admin API key

Generate an admin-role key from Settings → API Keys on the dashboard, then trade it for a session cookie:

COOKIE_JAR=/tmp/nfltr-session-cookies.txt

curl -sS -c "$COOKIE_JAR" -H "Content-Type: application/json" \
  -d '{"api_key":"'"$NFLTR_ADMIN_API_KEY"'"}' \
  https://nfltr.xyz/session

Confirm the session is authenticated before scripting further:

curl -sS -b "$COOKIE_JAR" https://nfltr.xyz/session

List connected agents

curl -sS -b "$COOKIE_JAR" https://nfltr.xyz/api/v1/dashboard/agents

Mirrors the My Agents panel: agent id, flavor, capacity, readiness, and last heartbeat.

Read account and global settings

curl -sS -b "$COOKIE_JAR" https://nfltr.xyz/api/v1/dashboard/settings
curl -sS -b "$COOKIE_JAR" https://nfltr.xyz/api/v1/dashboard/global-settings

Manage fleet tokens

Fleet tokens provision new workers without hand-copying an API key onto each machine. List existing tokens:

curl -sS -b "$COOKIE_JAR" https://nfltr.xyz/api/v1/dashboard/fleet-tokens

Push a planner digest

If you run a custom planner integration instead of nfltr orch, push task state to the dashboard the same way the built-in coordinator does. This endpoint accepts your regular API key directly (no session needed):

curl -sS -H "X-API-Key: $NFLTR_API_KEY" -H "Content-Type: application/json" \
  -d '{"tasks":[{"task_id":"custom-planner-1","state":"running","worker_id":"worker-1",
      "events":[{"at":"2026-01-01T00:00:00Z","kind":"progress","detail":"custom planner tick"}]}]}' \
  https://nfltr.xyz/api/v1/orchestration/digest

Once accepted, the same task appears in the dashboard's live activity feed and orchestration DAG — see nfltr orch: A Visual User Guide for what that looks like.

Related docs