-
Notifications
You must be signed in to change notification settings - Fork 246
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #679 from tursodatabase/document-admin-api
partially document admin API
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Libsql-server admin API documentation | ||
|
||
This document describes the admin API endpoints. | ||
|
||
The admin API is used to manage namespaces on a `sqld` instance. Namespaces are isolated database within a same sqld instance. | ||
|
||
To enable the admin API, and manage namespaces, two extra flags need to be passed to `sqld`: | ||
- `--admin-listen-addr <addr>:<port>`: the address and port on which the admin API should listen. It must be different from the user API listen address (whi defaults to port 8080). | ||
- `--enable-namespaces`: enable namespaces for the instance. By default namespaces are disabled. | ||
|
||
## Routes | ||
|
||
``` | ||
POST /v1/namespaces/:namespace/create | ||
``` | ||
Create a namespace named `:namespace`. | ||
body: | ||
```json | ||
{ | ||
"dump_url"?: string, | ||
} | ||
``` | ||
|
||
``` | ||
DELETE /v1/namespaces/:namespace | ||
``` | ||
|
||
Delete the namespace named `:namespace`. | ||
|
||
``` | ||
POST /v1/namespaces/:namespace/fork/:to | ||
``` | ||
Fork `:namespace` into new namespace `:to` |