On this page

Endpoints

Base paths of every project service and the most common REST operations.

#Base paths

ServiceEndpoint
REST APIhttps://<project-ref>.p.stitchdb.com/rest/v1/
Authhttps://<project-ref>.p.stitchdb.com/auth/v1/
Storagehttps://<project-ref>.p.stitchdb.com/storage/v1/
Realtimewss://<project-ref>.p.stitchdb.com/realtime/v1/
REST API on read replicashttps://<project-ref>-ro.p.stitchdb.com/rest/v1/

#Operations

OperationRequest
List rowsGET /rest/v1/todos?select=*
FilterGET /rest/v1/todos?is_complete=eq.true&id=gt.10
Order and paginateGET /rest/v1/todos?order=created_at.desc&limit=20&offset=40
InsertPOST /rest/v1/todos with a JSON body
UpdatePATCH /rest/v1/todos?id=eq.1
DeleteDELETE /rest/v1/todos?id=eq.1
Call a functionPOST /rest/v1/rpc/function_name

#Status codes

CodeMeaning
401Missing or invalid API key, or an expired access token
403The feature is not included in your plan, or Row Level Security blocked a write
413Upload larger than allowed, or file storage over its limit
429Too many requests per second for your plan
503The project is paused (project_paused) or suspended