Indice degli endpoint
Ogni route montata dal server, in un’unica tabella, con i requisiti necessari per raggiungerla.
I percorsi assumono il basePath predefinito di /api; REBASE_BASE_PATH li sposta
tutti insieme. /health, /livez e /metrics si trovano intenzionalmente all’esterno,
poiché un orchestratore esegue probe su /health e non dovrebbe dover conoscere il percorso
di base. /health è montato anche sotto di esso, quindi /api/health risponde allo
stesso modo invece di restituire un 404 proprio nel momento in cui qualcuno sta verificando
se il server è attivo.
Un gate — tooling/scripts/docs-verify/check-endpoint-index.mjs — confronta questa
tabella con le route registrate dal sorgente, in modo che una nuova superficie non possa
essere aggiunta senza comparire qui.
| Gate | Significato |
|---|---|
| none | Non autenticato. Chiunque possa raggiungere l’host può invocarlo |
| session | Un chiamante autenticato: un access token o una chiave API con ambito limitato all’operazione |
resource:action |
Un chiamante che possiede quello scope: un admin, una persona il cui ruolo lo dichiara, una chiave API creata con esso, oppure la service key |
| RLS | Autenticato, dopodiché il database decide riga per riga — vedi Security Rules |
| dev | Montato solo al di fuori della produzione |
Generato per collection, quindi i percorsi contengono i tuoi slug anziché un elenco
fisso. :slug è lo slug di una collection.
| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
GET |
/api/data/collections |
session | REST API |
GET |
/api/data/:slug |
RLS | Querying |
POST |
/api/data/:slug |
RLS | REST API |
POST |
/api/data/:slug/query |
RLS | L’elenco, con i parametri di query nel body — Query troppo lunghe per un URL |
GET |
/api/data/:slug/count |
RLS | Querying |
POST |
/api/data/:slug/count |
RLS | Il conteggio, con i parametri di query nel body — Query troppo lunghe per un URL |
GET |
/api/data/:slug/aggregate |
RLS | REST API |
GET |
/api/data/:slug/:id |
RLS | REST API |
PATCH |
/api/data/:slug/:id |
RLS | REST API |
PUT |
/api/data/:slug/:id |
RLS | Alias deprecato di PATCH — stessa scrittura parziale, risponde con Deprecation: true |
DELETE |
/api/data/:slug/:id |
RLS | REST API |
POST |
/api/data/:slug/bulk |
RLS | Inserisce più righe, opzionalmente eseguendo l’upsert — REST API |
PATCH |
/api/data/:slug/bulk |
RLS | Aggiorna più righe per id — REST API |
POST |
/api/data/:slug/bulk/delete |
RLS | Elimina più righe per id — REST API |
POST |
/api/data/_batch |
RLS | Scrive attraverso più collection in un’unica transazione — Scrittura tramite REST |
GET |
/api/data/:slug/:id/history |
RLS | Entity History |
POST |
/api/data/:slug/:id/history/:historyId/revert |
RLS | Entity History |
Il conteggio e l’aggregazione sono route a sé stanti, registrate prima di /:id affinché
aggregate non venga interpretato come l’id di un’entità. ?select= e ?groupBy= sono
i relativi parametri, e select è obbligatorio su /aggregate.
La ricerca testuale, la ricerca vettoriale, l’inclusione di relazioni e la selezione dei campi
sono parametri di query su GET /api/data/:slug anziché route — search,
vector_search, include, fields. Vedi REST API.
Un progetto che non dichiara collection e non ne analizza alcuna fornisce questo prefisso
come un singolo 404 NO_COLLECTIONS. Vedi Solo backend.
Autenticazione
Sezione intitolata “Autenticazione”| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
GET |
/api/auth/config |
none | Cosa può offrire la schermata di accesso: registrazione, ripristino della password, magic link, codici via email, accesso ospite, provider OAuth, e se la configurazione del primo amministratore è in sospeso |
POST |
/api/auth/register |
none | Autenticazione |
POST |
/api/auth/login |
none | Endpoint di autenticazione |
POST |
/api/auth/refresh |
none (un refresh token) | Endpoint di autenticazione |
POST |
/api/auth/logout |
session | Endpoint di autenticazione |
GET |
/api/auth/me |
session | Endpoint di autenticazione |
PATCH |
/api/auth/me |
session | Endpoint di autenticazione |
GET |
/api/auth/sessions |
session | Endpoint di autenticazione |
DELETE |
/api/auth/sessions |
session | Revoca tutte le altre sessioni |
DELETE |
/api/auth/sessions/:id |
session | Ne revoca una |
POST |
/api/auth/forgot-password |
none | Autenticazione |
POST |
/api/auth/reset-password |
none (un token di reset) | Autenticazione |
POST |
/api/auth/change-password |
session | Autenticazione |
POST |
/api/auth/send-verification |
session | Autenticazione |
GET |
/api/auth/verify-email |
none (un token di verifica) | Autenticazione |
POST |
/api/auth/verify-email |
none (un token di verifica, e una sessione o la password per mantenerla) | Verifica email |
POST |
/api/auth/magic-link |
none | Autenticazione |
POST |
/api/auth/magic-link/verify |
none (un link token) | Autenticazione |
POST |
/api/auth/otp |
none | Codici monouso via email |
POST |
/api/auth/otp/verify |
none (un codice) | Codici monouso via email |
POST |
/api/auth/anonymous |
none | Sessioni guest. Disattivato a meno che non sia impostato ALLOW_ANONYMOUS |
POST |
/api/auth/anonymous/link |
session (un guest) | Trasforma un guest in un account |
POST |
/api/auth/find-user |
session | Disattivato a meno che non sia impostato AUTH_ALLOW_USER_LOOKUP — costituisce una superficie di enumerazione |
POST |
/api/auth/:provider |
none | Uno per ciascun provider OAuth/OIDC configurato |
POST |
/api/auth/link/:provider |
session | Collega un provider all’account attualmente autenticato |
POST |
/api/auth/mfa/enroll |
session | MFA |
POST |
/api/auth/mfa/verify |
session | MFA |
GET |
/api/auth/mfa/factors |
session | MFA |
DELETE |
/api/auth/mfa/unenroll |
session | MFA |
POST |
/api/auth/mfa/recovery-codes |
session (aal2) |
MFA |
POST |
/api/auth/mfa/challenge |
none (un accesso in corso) | MFA |
POST |
/api/auth/mfa/challenge/verify |
none (un ID di challenge) | MFA |
GET |
/api/auth/scopes |
session | Ogni scope noto a questo backend, e quelli che possiede il chiamante — Ruoli e scope |
GET |
/api/auth/keys |
session (un account) | Le chiavi personali del chiamante |
POST |
/api/auth/keys |
session (un account) | La chiave in chiaro viene restituita una sola volta. 403 PERSONAL_KEYS_DISABLED a meno che la collection users non imposti auth.personalKeys |
DELETE |
/api/auth/keys/:id |
session (un account) | Revoca una delle chiavi del chiamante |
GET |
/.well-known/jwks.json |
none | Il JWKS pubblico, quando è configurata la firma asimmetrica |
Amministrazione
Sezione intitolata “Amministrazione”Tutto ciò che si trova sotto /api/admin richiede uno scope del piano di amministrazione, e ogni
superficie indica il proprio: users:read elenca gli account, cron:write avvia un job.
Un admin li possiede tutti, e così la service key. Una persona possiede quelli
dichiarati dai suoi ruoli, e una chiave API quelli con cui è stata creata. Una chiave limitata a
una collection non può accedere a nulla di tutto questo. Vedi Ruoli e scope.
| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
POST |
/api/admin/bootstrap |
none, e solo finché non esiste alcun admin | Rifiutato in produzione — vedi Bootstrap del primo utente |
GET |
/api/admin/users |
users:read |
Gestione utenti |
POST |
/api/admin/users |
users:write |
Gestione utenti. I ruoli oltre a quelli del chiamante vengono rifiutati |
GET |
/api/admin/users/pick |
users:read, oppure accesso in scrittura a una collection con un campo userSelect |
La lettura del selettore utenti: solo id, nome, email e avatar. Una collection le cui regole di scrittura sono SQL grezzo non conta |
GET |
/api/admin/users/:uid |
users:read |
Gestione utenti |
PUT |
/api/admin/users/:uid |
users:write |
Rifiutato per un account che possiede più del chiamante |
DELETE |
/api/admin/users/:uid |
users:write |
Rifiutato per un account che possiede più del chiamante |
POST |
/api/admin/users/:uid/reset-password |
users:write |
Rilascia una password temporanea |
DELETE |
/api/admin/users/:uid/mfa |
users:write |
Rimuove i secondi fattori e i codici di recupero dell’account, termina le sue sessioni |
GET |
/api/admin/roles |
users:read |
admin e i ruoli dichiarati dal progetto, con i loro scope |
GET |
/api/admin/api-keys |
keys:read |
Chiavi API. Mai una chiave API |
POST |
/api/admin/api-keys |
keys:write |
La chiave in testo non crittografato viene restituita una sola volta, al momento della creazione |
GET |
/api/admin/api-keys/:id |
keys:read |
Chiavi API |
PUT |
/api/admin/api-keys/:id |
keys:write |
Chiavi API |
DELETE |
/api/admin/api-keys/:id |
keys:write |
Chiavi API |
GET |
/api/admin/cron |
cron:read |
Cron Job |
GET |
/api/admin/cron/:id |
cron:read |
Cron Job |
PUT |
/api/admin/cron/:id |
cron:write |
Abilita o disabilita un job |
GET |
/api/admin/cron/:id/logs |
cron:read |
Cron Job |
POST |
/api/admin/cron/:id/trigger |
cron:write |
Esegue un job immediatamente. Da 0.25 ?async=1 risponde 202 appena è partito — Cron Jobs API |
GET |
/api/admin/backups |
backups:read |
Inventario dei backup |
GET |
/api/admin/backups/download |
backups:read |
Trasmette in streaming un backup. Con ?token= da un link di download non serve alcun header, solo per quel backup |
POST |
/api/admin/backups/download-url |
backups:read |
Da 0.25 Un link a un backup, { key } → { url, token, expiresIn }, valido per 60 secondi — Backup |
GET |
/api/admin/storage/orphans |
database:read |
Da 0.25 File archiviati che nessuna riga nomina, ?storageId=&olderThanHours= — ciò che stampa rebase storage orphans |
DELETE |
/api/admin/storage/orphans |
database:write |
Da 0.25 Li individua di nuovo e li elimina; 409 STORAGE_SCAN_INCOMPLETE quando una collection non ha potuto essere letta |
POST |
/api/admin/storage/move |
database:write |
Da 0.25 Copia una cartella in un’altra sorgente con le stesse chiavi, una pagina per chiamata — ciò che invia rebase storage move |
GET |
/api/admin/logs |
logs:read |
Il buffer dei log recenti |
GET |
/api/admin/logs/latest |
logs:read |
Le voci più recenti |
GET |
/api/admin/logs/stream |
logs:read |
Server-sent events |
GET |
/api/admin/rls-audit |
schema:read |
L’ultimo risultato dell’audit pianificato |
POST |
/api/admin/sql/csv |
database:write |
Da 0.25 Trasmette in streaming l’intero risultato di una query di sola lettura come CSV — «Download full result as CSV» di Studio |
GET |
/api/admin/schema/status |
schema:read |
Modifica dello schema in tempo reale |
POST |
/api/admin/schema/plan |
schema:read |
Pianifica una modifica; non ne applica mai una |
POST |
/api/admin/schema/apply |
schema:write |
Solo una persona, a meno che non sia impostato REBASE_LIVE_SCHEMA_ALLOW_MACHINE_APPLY |
GET |
/api/admin/schema-editor/status |
schema:read |
Indica se l’editor è disponibile e il motivo quando non lo è |
POST |
/api/admin/schema-editor/collection/save |
schema:write |
Studio — riscrive il sorgente della collection |
POST |
/api/admin/schema-editor/collection/delete |
schema:write |
Studio |
POST |
/api/admin/schema-editor/property/save |
schema:write |
Studio |
POST |
/api/admin/schema-editor/property/delete |
schema:write |
Studio |
GET |
/api/admin/dev/emails |
dev + users:write |
Email catturate dal transport di sviluppo invece di essere inviate |
DELETE |
/api/admin/dev/emails |
dev + users:write |
Svuota la casella di posta catturata |
/api/admin/cron, /api/admin/logs e /api/admin/schema-editor sono serviti anche
sui loro percorsi antecedenti alla versione 0.17 senza il segmento /admin. Tali alias
esistono per i progetti che non sono ancora stati migrati; scrivi il nuovo codice
puntando al percorso canonico.
Storage
Sezione intitolata “Storage”| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
POST |
/api/storage/upload |
session + storageAuthorize |
Storage |
GET |
/api/storage/file/* |
session + storageAuthorize |
Storage |
DELETE |
/api/storage/file/* |
session + storageAuthorize |
Storage |
GET |
/api/storage/metadata/* |
session + storageAuthorize |
Storage |
POST |
/api/storage/metadata |
session + storageAuthorize, per chiave |
Da 0.25 Storage: metadati di fino a 100 oggetti |
GET |
/api/storage/list |
session + storageAuthorize |
Storage |
POST |
/api/storage/folder |
session + storageAuthorize |
Storage |
GET |
/api/storage/sources |
session | Le sorgenti di storage denominate servite da questo backend |
OPTIONS |
/api/storage/tus |
none | Caricamenti riprendibili: le versioni e le estensioni TUS supportate da questo server |
POST |
/api/storage/tus |
session + storageAuthorize |
Upload ripristinabili: creazione |
GET |
/api/storage/tus/:id |
il proprietario dell’upload | Upload ripristinabili: offset |
PATCH |
/api/storage/tus/:id |
il proprietario dell’upload | Upload ripristinabili: append |
DELETE |
/api/storage/tus/:id |
il proprietario dell’upload | Upload ripristinabili: cancellazione |
Un deployment senza storage configurato risponde su questo prefisso con un errore 501
indicando la variabile necessaria, anziché restituire un 404 come se la funzionalità non esistesse.
Funzioni
Sezione intitolata “Funzioni”| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
| any | /api/functions/<name> |
qualunque cosa dichiari la funzione. Una chiave API ha bisogno anche di functions:invoke |
Funzioni personalizzate |
Una route per file presente in backend/functions/, quindi i percorsi dipendono dal tuo
progetto. GET /api/functions non li elenca: l’inventario degli endpoint personalizzati
di un deployment non è pubblico.
Metadati e operazioni
Sezione intitolata “Metadati e operazioni”| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
GET |
/livez |
none | Sola liveness: indica se questo processo è in esecuzione. Non tocca il database, motivo per cui è il percorso di probe che un container dovrebbe utilizzare — RUNTIME_LIVENESS_PATH |
GET |
/health, /api/health |
none | Liveness e readiness. Riporta ogni data source configurata, non soltanto quella predefinita |
GET |
/api/docs |
none (schema:read in produzione) |
Il documento OpenAPI 3.0 |
GET |
/api/swagger |
none | Swagger UI. Solo in sviluppo a meno che non sia impostato REBASE_ENABLE_SWAGGER |
GET |
/api/meta/schema-version |
none | L’hash dello schema da cui è stato compilato questo backend, e nient’altro |
GET |
/api/meta/contract |
schema:read |
Il contratto completo delle collection, per rebase generate-sdk --from. 404 se non è configurata alcuna autenticazione |
GET |
/metrics |
REBASE_METRICS_TOKEN se impostato |
Metriche di Prometheus, quando REBASE_METRICS=true |
GET |
/metrics/history |
REBASE_METRICS_TOKEN se impostato |
Le serie registrate alla base dei grafici di Studio. 501 su un runtime privo di backend |
Le connessioni WebSocket arrivano come un aggiornamento HTTP (upgrade) sullo stesso server anziché su un percorso dedicato — vedi Realtime.
Superficie MCP
Sezione intitolata “Superficie MCP”Montata solo quando REBASE_MCP_ENABLED=true, che richiede anche
REBASE_PUBLIC_URL — vedi
Configurazione. Disattivata per
impostazione predefinita: nessun REBASE_ROLE la abilita, poiché concede l’accesso al progetto
a software di terze parti e questa è una decisione che spetta a una persona.
I documenti .well-known risiedono all’origine, non sotto basePath: le RFC 8414
e RFC 9728 definiscono tali percorsi rispetto all’origine e un client li richiede
prima di possedere qualsiasi token.
| Metodo | Percorso | Gate | Dettagli |
|---|---|---|---|
GET |
/.well-known/oauth-protected-resource |
none | Metadati RFC 9728 che indicano questa risorsa e il relativo server di autorizzazione. Serviti anche nella forma con suffisso del percorso |
GET |
/.well-known/oauth-authorization-server |
none | Metadati RFC 8414: gli endpoint, i tipi di grant e i metodi PKCE supportati da questo deployment |
POST |
/mcp |
OAuth bearer, oppure una chiave API | L’endpoint del protocollo MCP. Agisce come l’utente autenticato (o come chiunque sia l’identità con cui agisce la chiave), quindi ogni operazione di lettura e scrittura è soggetta allo stesso RLS. Gli scope data:* decidono quali tool vengono offerti |
GET |
/mcp |
OAuth bearer, oppure una chiave API | Risponde 405 con Allow: POST, DELETE: questo server non apre stream avviati dal server. Il token viene verificato per primo, quindi uno mancante o non valido riceverà invece una richiesta di autenticazione 401 |
DELETE |
/mcp |
none | Risponde 204. L’endpoint non mantiene alcuna sessione, quindi non c’è nulla da terminare |
POST |
/api/oauth/register |
rate-limited | Registrazione dinamica dei client RFC 7591. Rifiutata quando REBASE_MCP_OPEN_REGISTRATION=false |
GET |
/api/oauth/authorize |
session | La schermata di consenso a cui viene reindirizzato il client |
POST |
/api/oauth/authorize/decision |
session | La risposta della persona — approva o nega |
POST |
/api/oauth/token |
client credentials + PKCE | Scambia un authorization code, oppure effettua il refresh |
POST |
/api/oauth/revoke |
client credentials | Revoca dei token RFC 7009 |
GET |
/api/oauth/grants |
session | Quali client sono stati approvati da questo utente |
DELETE |
/api/oauth/grants/:clientId |
session | Ne revoca uno, consentendo a una persona di annullare un consenso senza l’intervento di un amministratore |
Correlati
Sezione intitolata “Correlati”- REST API — le route dei dati nel dettaglio: filtri, ordinamento, paginazione, errori
- Endpoint di autenticazione — formati di richiesta e risposta per la tabella di autenticazione sopra indicata
- Ambiente e configurazione — le variabili che determinano quali di questi endpoint vengono montati