Introduction
Deploro is a self-hosted developer platform — connect a repo and get a live app with its own
PostgreSQL database, file storage, realtime, and a custom domain. This site documents the REST
API and the deploro CLI so you can drive the platform from code, scripts, or CI.
What is Deploro
Every Deploro project gets an isolated PostgreSQL database, a Cloudflare Worker or Pages deployment, R2-backed file storage, realtime WebSocket updates, outbound webhooks, and a REST API that's generated automatically from your schema (API Studio). You can manage all of this from the dashboard, the CLI, or by calling the API directly — they're three faces of the same platform, backed by the same Worker.
Three ways to use Deploro
Dashboard
Point-and-click project management, table editor, SQL console, deploy logs, and settings.
app.deploro.comCLI
Script anything the dashboard can do — provisioning, migrations, deploys, env vars — from a terminal or CI job.
npm i -g @deploro/cliREST API
The same Worker API that powers the dashboard and CLI. Call it directly with a personal access token.
api.deploro.comAPI Studio
Every table in your project database gets its own REST API and OpenAPI 3.1 spec, generated automatically.
/api/projects/:id/studioBase URL
All API requests go to the platform Worker:
https://api.deploro.com
Per-project end-user auth (Auth-as-a-Service — OTP, email/password, OAuth sign-in for your
own app's users) is mounted at /auth/:slug/* on the same host. Inbound GitHub
webhooks are delivered to /webhooks/github, also on the same host.
Authentication
The API supports two authentication modes:
-
Session cookie — what the dashboard uses.
POST /api/auth/loginsets anhttpOnlydeploro_sessioncookie (JWT, 7-day expiry). Send it withcredentials: "include"on cross-origin requests. -
Personal access token (PAT) — what the CLI and scripts use. Create one from
the dashboard or with
deploro token create, then send it as a bearer token:
curl https://api.deploro.com/api/projects \
-H "Authorization: Bearer deploro_pat_..."
A PAT is scoped to one or more projects and to a read or write capability level, set at
creation time (deploro token create <name> --read --write --project my-app).
It cannot manage other platform users or issue new tokens — for those, log in and use a
session instead. Endpoints marked admin
in the reference require an admin-role account regardless of which auth mode is used.
gallium_pat_... — both prefixes are accepted everywhere a token is read.
CLI quickstart
The fastest way to explore the API surface is through the CLI, which talks to the same endpoints documented here.
Install & log in
Install the CLI and authenticate with a personal access token from the dashboard.
Create a project
Spin up a project and provision its isolated Postgres database.
Deploy
Connect a repo for auto-deploy on push, or trigger a manual deploy.
# install
npm install -g @deploro/cli
# authenticate (paste a PAT from Dashboard → Settings → Tokens)
deploro login --token deploro_pat_...
# create a project and provision its database
deploro create my-app
deploro db create
# connect GitHub and deploy on every push
deploro github connect
deploro repo link my-org/my-app --branch main
# or trigger a deploy by hand
deploro deploy trigger
deploro deploy statusSee the full CLI reference for every command, or the API reference to call the same operations directly over HTTP.