DoltHub API v2#
API version: v2
The v2 API is the current generation of the DoltHub HTTP surface. Every endpoint lives under https://www.dolthub.com/api/v2/.
Note: please send requests to
https://www.dolthub.com, nothttps://dolthub.com.
Compared to v1alpha1, v2 commits to:
- Consistent HTTP semantics (correct status codes, idempotent GETs, etc.)
- A single error model (RFC 9457 problem details)
- A uniform success Envelope wrapping every response
- A standardized long-running operations protocol for async mutations
All endpoints#
User#
| Method | Path | What it does |
|---|---|---|
| GET | /api/v2/user | Get the authenticated user |
Database#
| Method | Path | What it does |
|---|---|---|
| POST | /api/v2/databases | Create a database |
| GET | /api/v2/databases/{owner}/{database} | Get a database |
| GET | /api/v2/databases/{owner}/{database}/branches | List branches |
| POST | /api/v2/databases/{owner}/{database}/branches | Create a branch |
| GET | /api/v2/databases/{owner}/{database}/tags | List tags |
| POST | /api/v2/databases/{owner}/{database}/tags | Create a tag |
| GET | /api/v2/databases/{owner}/{database}/forks | List forks |
| POST | /api/v2/databases/{owner}/{database}/forks | Fork a database |
| GET | /api/v2/databases/{owner}/{database}/releases | List releases |
| POST | /api/v2/databases/{owner}/{database}/releases | Create a release |
| GET | /api/v2/databases/{owner}/{database}/sql | Run a read-only SQL query |
| POST | /api/v2/databases/{owner}/{database}/sql | Run a read-only SQL query (large-query variant) |
| GET | /api/v2/databases/{owner}/{database}/pulls | List pull requests |
| POST | /api/v2/databases/{owner}/{database}/pulls | Create a pull request |
| GET | /api/v2/databases/{owner}/{database}/pulls/{pull_number} | Get a pull request |
| PATCH | /api/v2/databases/{owner}/{database}/pulls/{pull_number} | Update a pull request |
| GET | /api/v2/databases/{owner}/{database}/pulls/{pull_number}/comments | List pull request comments |
| POST | /api/v2/databases/{owner}/{database}/pulls/{pull_number}/comments | Add a pull request comment |
| POST | /api/v2/databases/{owner}/{database}/pulls/{pull_number}/merge | Merge a pull request |
| POST | /api/v2/databases/{owner}/{database}/imports/uploads | Initialize a multipart upload |
| POST | /api/v2/databases/{owner}/{database}/imports | Create an import operation |
Operations#
| Method | Path | What it does |
|---|---|---|
| GET | /api/v2/databases/{owner}/{database}/operations | List a database’s async operations |
| GET | /api/v2/operations/{operation_id} | Get an async operation |