Skip to content
All templates

API Starter

A backend for your own web or mobile frontend: accounts, owner-only data, protected file attachments, live updates and a custom route.

PocketBase API

Deploy

# Install
curl -fsSL https://raw.githubusercontent.com/pocketbasecloud/cli/main/scripts/install.sh | sh
# Login
pbc login
# Clone
git clone https://github.com/pocketbasecloud/starters && cd starters/api
# Deploy
pbc pocketbase deploy --new api && pbc pocketbase info --name api

Overview

A backend for your own web or mobile frontend: accounts, owner-only data, protected file attachments, live updates and a custom route. It is one PocketBase and nothing else: the API is all there is, so pair it with any frontend.

Key features

  • Owner-only rules: users read and change only their own records and cannot hand them to someone else.
  • Protected files: attachments need a short-lived file token from their owner.
  • Realtime: subscribe from any PocketBase SDK; rules apply to live events too.
  • Hooks to extend: a custom /api/me/summary route and a record hook to copy from.

Make it yours

The starter’s README lists the three things to change first. Sample data comes from the first migration; delete it in the PocketBase admin when you are ready.