v1alpha1 API#

API version: v1alpha1

The v1alpha1 API is the main HTTP surface for managing databases on DoltHub and DoltLab. Every endpoint lives under https://www.dolthub.com/api/v1alpha1/.

Note: please send requests to https://www.dolthub.com, not https://dolthub.com.

Browse the per-resource pages in the sidebar, or jump straight to an endpoint from the index below.

All endpoints#

SQL#

Method	Path	What it does
GET	`/{owner}/{database}`	SQL read queries on the default branch
GET	`/{owner}/{database}/{ref}`	SQL read queries on a specified ref
POST	`/{owner}/{database}/write/{from_branch}/{to_branch}`	SQL write query and merge branches
GET	`/{owner}/{database}/write`	Check write query operation status

User#

Method	Path	What it does
GET	`/user`	Get current user

Databases#

Method	Path	What it does
POST	`/database`	Create a new Dolt database
POST	`/fork`	Fork an existing Dolt database
GET	`/fork`	Check fork operation status
GET	`/{owner}/{database}/forks`	List Forks

Branches#

Method	Path	What it does
POST	`/{owner}/{database}/branches`	Create Branch
GET	`/{owner}/{database}/branches`	List Branches

Pull Requests#

Method	Path	What it does
POST	`/{owner}/{database}/pulls`	Create a new pull request
GET	`/{owner}/{database}/pulls/{pull_id}`	Get pull request by ID
PATCH	`/{owner}/{database}/pulls/{pull_id}`	Update Pull Request
GET	`/{owner}/{database}/pulls`	List pull requests of a database
POST	`/{owner}/{database}/pulls/{pull_id}/comments`	Add comment to pull request
POST	`/{owner}/{database}/pulls/{pull_id}/merge`	Merge a pull request
GET	`/{owner}/{database}/pulls/{pull_id}/merge`	Check merge operation status

Releases#

Method	Path	What it does
POST	`/{owner}/{database}/releases`	Create Release
GET	`/{owner}/{database}/releases`	List Releases

Tags#

Method	Path	What it does
POST	`/{owner}/{database}/tags`	Create Tag
GET	`/{owner}/{database}/tags`	List Tags

File Uploads#

Method	Path	What it does
POST	`/{owner}/{database}/upload`	Upload a file to a DoltHub database
GET	`/{owner}/{database}/upload`	Check import operation status

Jobs#

Method	Path	What it does
GET	`/users/{username}/operations`	List operations
GET	`/{owner}/{database}/jobs`	List jobs