Documentation
Everything you need to integrate RestWard.
Documentation sections
Quick Start
Create your account and get into your workspace, then connect a database and build your first API.
CLI
Install the restward CLI and drive RestWard from your terminal and CI.
API Reference
Authenticate requests to your generated APIs and explore their endpoints and OpenAPI specs.
Examples
Copy-paste requests in curl, JavaScript, Python and C#, with real responses.
Guides
Connections, API building, the dashboard, and troubleshooting walkthroughs.
- Connecting a database
- Building & publishing APIs
- Dashboard & navigation
- Logs & troubleshooting
- Rate limiting
- Choosing data-plane auth: API key vs JWT vs mTLS
- RBAC & multi-tenancy
- Mutual TLS (mTLS) for a generated API
- Single sign-on with Entra ID and SCIM provisioning
- API metrics
- Deleting your organization
- Getting your GDPR report
OpenAPI, served from your running API
Every generated API serves an OpenAPI spec at /openapi.json
and an enhanced spec at /openapi-enhanced.json,
regenerated from the live schema. Point Postman, codegen tools, or your internal portal at either URL.