API, CLI, and Admin Reference
API overview
HTTP surfaces for dFlow: tRPC, Payload CMS API, webhooks, and why there is no separate public dashboard REST API.
dFlow’s dashboard is a Next.js application. Most reads and writes you perform in the UI go through Next.js Server Actions (tenant-aware mutations and many data loads) or, where listed below, tRPC procedures. There is no documented, versioned public REST API aimed at customers for “everything in the dashboard” as of this writing.
Primary HTTP entry points (dashboard app)
| Surface | Typical role | Notes |
|---|---|---|
| Server Actions | Forms, tenant-scoped CRUD, cache revalidation | Implemented under packages/core/src/actions/ with protectedClient and actionName metadata. See the actions reference pages in this section. |
| tRPC | Typed queries and mutations, often with React Query on the client | Served from /api/trpc/[trpc] (see apps/dashboard route handlers). Routers live under packages/cloud/src/trpc/routers/. |
| Payload CMS REST | CMS and admin-style access | Catch-all /api/[...slug] in the Payload segment of the dashboard app exposes Payload’s HTTP API where enabled. Treat this as internal / operator, not a customer integration contract. |
| MCP | AI / editor clients (Model Context Protocol) | /api/mcp: workspace tools with OAuth 2.0 (not API-key auth). See dFlow MCP. |
Webhooks and callbacks
Dedicated routes under /api/... also handle provider callbacks (for example GitHub deploy hooks and Discord OAuth). These are integration endpoints, not a general “dFlow API” for your own scripts.
How this relates to your workloads
- Your running Services (apps and databases) expose their own HTTP or database protocols on Worker Nodes. That is separate from the control plane APIs above.
- Git providers, Docker registries, and cloud accounts are connected through flows documented under Integrations under Integrations in the sidebar.
Learn more
- dFlow MCP for how to connect, OAuth 2.0 sign-in, and the tool list.
- tRPC and backend reference for router layout and procedures.
- Service actions and Application / environment actions for named server mutations and reads.
- CLI overview for command-line style operations outside HTTP APIs.