API Reference
Reference documentation for interacting with your RestAPI.com APIs via HTTP.
API Paths
Hosted web apps access the API through virtual paths — no CORS configuration needed:
/api/{collection}
/api/{collection}/{id}
Examples:
/api/products
/api/products/f38fa478-842e-4599-8cbc-918a34b3b789
External Clients
External clients use the full region-specific URL:
https://<region>.restapi.com/<api-name>/{collection}
| Region | Prefix | Location |
|---|---|---|
| EU | eu | Amsterdam |
| Norway | no | Norway |
Additional Virtual Paths
| Path | Description |
|---|---|
/api | Region-free, CORS-free |
/<region>-api | Region-specific, CORS-free (slightly lower latency) |
/login | Hosted authentication page |
Sections
- Quick Reference — Structured table of all
/apiendpoints - Authentication — JWT tokens, identity providers, service accounts
- HTTP Methods — GET, POST, PUT, PATCH, DELETE operations
- Nested Children — Transactional parent-child updates
- Transactions — Atomic operations via WebSocket
- Blobs — Binary file storage and retrieval
- Functions — Serverless functions for custom business logic
- Hosted Webapps — Static site hosting and virtual paths
- Real Time — WebSocket connections and live updates