HTTP Database Endpoints¶
All database endpoints return the standard response envelope:
When authentication is enabled, include:
Endpoints¶
| Method | Path | Body fields | Description |
|---|---|---|---|
POST |
/create_database |
database_name, drop_if_exists |
Create a database or recreate it when requested. |
POST |
/drop_database |
database_name |
Drop a database. |
POST |
/delete_database |
database_name |
Alias for dropping a database. |
POST |
/database_exists |
database_name |
Check whether a database exists. |
GET |
/list_databases |
none | List database names. |
POST |
/snapshot_database |
database_name, snapshot_path |
Create a database snapshot on the server filesystem. |
POST |
/restore_database |
database_name, snapshot_path, overwrite |
Restore a database snapshot. |
Examples¶
Create a database:
curl -X POST http://127.0.0.1:7637/create_database \
-H "Content-Type: application/json" \
-d '{"database_name": "app", "drop_if_exists": false}'
List databases:
Restore a snapshot:
curl -X POST http://127.0.0.1:7637/restore_database \
-H "Content-Type: application/json" \
-d '{"database_name": "app_restored", "snapshot_path": "./app.snapshot", "overwrite": true}'