API Collection
60+ endpoints across all services, correct gateway paths, auto-save scripts for tokens.
Postman Collection
Explore and test every Pulsabase REST API endpoint using the official Postman collection. One URL, all services — everything is routed through the nginx gateway.
Download
Section titled “Download”Environment
Pre-configured with a single base_url. Just fill in your api_key, client_id, and client_secret.
-
Import the collection
Open Postman → Import → drag
pulsabase-api.postman_collection.json. -
Import the environment
Environments → Import → upload
pulsabase-api.postman_environment.json. Select Pulsabase — Local Dev in the top-right dropdown. -
Set your variables
Variable Value Where to find it base_urlhttp://localhost(local) orhttps://your-project.pulsabase.io— api_keypk_live_xxxDashboard → Settings → API Keys project_idyour project ID Dashboard → Settings → General client_idOIDC client ID Dashboard → Settings → OIDC client_secretOIDC client secret Dashboard → Settings → OIDC -
Sign in and start testing
Run ** Auth — Sign In** or ** IDP — Token (Password Grant)**.
access_tokenandrefresh_tokenare automatically saved to your environment.
Gateway Routing
Section titled “Gateway Routing”All requests go through a single nginx gateway. The path prefix determines which service handles the request:
Endpoints Reference
Section titled “Endpoints Reference”Auth — Tenant Management (/auth/api/v1/…)
Section titled “Auth — Tenant Management (/auth/api/v1/…)”| Method | Path | Description |
|---|---|---|
POST | /auth/api/v1/tenants/signup | Create a developer account |
POST | /auth/api/v1/tenant/login | Sign in → returns tokens |
POST | /auth/api/v1/tenant/logout | Sign out |
POST | /auth/api/v1/tenant/mfa/enroll | Enroll TOTP MFA |
POST | /auth/api/v1/tenant/mfa/verify | Activate MFA |
POST | /auth/api/v1/tenant/mfa/disable | Disable MFA |
GET | /auth/api/v1/projects | List projects |
POST | /auth/api/v1/projects | Create project |
PUT | /auth/api/v1/projects/:id | Rename project |
DELETE | /auth/api/v1/projects/:id | Delete project |
POST | /auth/api/v1/projects/:id/regenerate-key | Regenerate API key |
GET | /auth/api/v1/projects/:id/publications | List realtime tables |
POST | /auth/api/v1/projects/:id/publications | Toggle realtime for a table |
GET | /auth/api/v1/plans | List plans |
IDP — End-User Auth / OIDC (root paths)
Section titled “IDP — End-User Auth / OIDC (root paths)”| Method | Path | Description |
|---|---|---|
GET | /.well-known/openid-configuration | OIDC discovery |
GET | /jwks.json | Public signing keys |
POST | /register | Register a new end-user |
POST | /token | Issue tokens (password / authorization_code / client_credentials / refresh_token) |
GET | /userinfo | Current user profile |
POST | /introspect | Inspect token (RFC 7662) |
POST | /revocation | Revoke token (RFC 7009) |
POST | /logout | Revoke session + refresh token |
POST | /mfa/enroll | Enroll TOTP MFA (end-user) |
POST | /mfa/verify | Activate MFA |
POST | /mfa/disable | Disable MFA |
POST | /password/reset/request | Request password reset email |
POST | /password/reset/confirm | Confirm reset with token |
POST | /password/change | Change password (authenticated) |
POST | /email/verify/request | Request email verification |
POST | /email/verify/confirm | Confirm email verification |
Core — Database (/v1/query)
Section titled “Core — Database (/v1/query)”Gateway rewrites /v1/* → /api/v1/* on pulsabase-core.
| Action | Description |
|---|---|
find | Select rows with filters, sort, limit, offset |
findOne | First matching row |
insert | Insert a row |
update | Update matching rows |
delete | Delete matching rows |
aggregate | COUNT / SUM / AVG / MIN / MAX with GROUP BY |
transaction | Multi-query atomic transaction |
vectorSearch | pgvector ANN similarity search |
rawSQL | Parameterized SQL |
Also: GET /v1/publication, POST /v1/publication
Storage (/storage/api/v1/storage/…)
Section titled “Storage (/storage/api/v1/storage/…)”| Method | Path | Description |
|---|---|---|
POST | /storage/api/v1/storage/upload | Upload file (multipart) |
POST | /storage/api/v1/storage/upload/confirm | Confirm upload |
GET | /storage/api/v1/storage/download/:id | Download file |
GET | /storage/api/v1/storage/objects | List objects |
GET | /storage/api/v1/storage/folders | List folders |
GET | /storage/api/v1/storage/usage | Storage usage stats |
DELETE | /storage/api/v1/storage/objects/:id | Delete file |
GET / POST / DELETE | /storage/api/v1/storage/policies | ACL policies |
Edge Functions (/edge/api/v1/…)
Section titled “Edge Functions (/edge/api/v1/…)”| Method | Path | Description |
|---|---|---|
GET / POST | /edge/api/v1/functions | List / create functions |
GET / PUT / DELETE | /edge/api/v1/functions/:id | Get / update / delete |
POST | /edge/api/v1/invoke/:name | Invoke (add ?async=true or ?dry_run=true) |
GET / POST / DELETE | /edge/api/v1/hooks | Before/after DB hooks |
GET / POST / DELETE | /edge/api/v1/webhooks | Inbound webhook receivers |
POST | /edge/webhooks/:project_id/:slug | Receive webhook (no auth) |
GET / POST / DELETE | /edge/api/v1/cron | Scheduled jobs |
GET / POST / PUT / DELETE | /edge/api/v1/email-templates | Email templates |
GET / POST / DELETE | /edge/api/v1/email-config | SMTP configuration |
GET | /edge/api/v1/executions | List executions |
GET | /edge/api/v1/executions/:id | Get execution detail |
GET | /edge/api/v1/executions/:id/events | Step-by-step log |
GET | /edge/api/v1/stats | Execution stats |
Health Checks
Section titled “Health Checks”| Path | Service |
|---|---|
/health | Gateway (aggregated) |
/health/auth/readyz | pulsabase-auth |
/health/idp/readyz | pulsabase-idp |
/health/core/readyz | pulsabase-core |
/health/storage/readyz | pulsabase-storage |