CloudBurrow API reference.
Browse the public HTTP reference for CloudBurrow’s local APIs and Google-compatible services, by release and source version.
Find the right version.
Choose a service to browse routes, parameters, schemas and examples. Each reference links to its OpenAPI file for use in your own tools.
- v0.3.0 Packaged · 0ea2594
- 1,082 HTTP operations
- Main From source · 0ea2594
- 1,082 HTTP operations
CloudBurrow APIs
Instance health, administration, state and local credentials.
| API | v0.3.0 | Main |
|---|---|---|
| CloudBurrow Control API | 15 HTTP operations | 15 HTTP operations |
| CloudBurrow Metadata and Credentials | 18 HTTP operations | 18 HTTP operations |
Google-compatible services
Local HTTP routes and schemas, with a compatibility matrix for each API.
HTTP, gRPC and native clients.
The public reference is read-only. Start your instance and use cloudburrow env to
get its actual endpoint. Run requests with your local client.
curl http://127.0.0.1:9000/healthz
- Check a specific operation
Use the full compatibility matrix for gRPC, test coverage and operations without an HTTP document. Browse the matrix.
- Object transfers
Storage JSON, XML and gRPC have different request formats. See Storage transports.
- Database connections
Connect to local PostgreSQL, MySQL or Valkey with the driver your application uses. See the data-plane setup. MongoDB drivers reach Firestore with MongoDB compatibility on its own TLS port. See Firestore.
Reference viewer by Scalar. Viewer license · Schema notices · HTTP mapping and gaps (JSON).