Datastore
Managed analytics datastore (Hanzo Datastore, ClickHouse-compatible wire) — dedicated per-org instance.
Managed analytics datastore (Hanzo Datastore, ClickHouse-compatible wire) — dedicated per-org instance.
| Base URL | https://api.hanzo.ai |
| Operations | 4 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
datastore
GetDatastore returns one Hanzo Datastore warehouse's metadata.
GET /v1/datastore/{name}
GetDatastore returns one Hanzo Datastore warehouse's metadata. It carries the warehouse's status, its instance address and the admin user the instance booted with — never the password. A still-booting instance reads "provisioning", reconciled from the operator's live view rather than the row.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9 |
DropDatastore deprovisions one Hanzo Datastore warehouse.
DELETE /v1/datastore/{name}
DropDatastore deprovisions one Hanzo Datastore warehouse. It reverts any app instance bound to it back to Base BEFORE tearing down the org's dedicated instance, then deletes the sealed credential and removes the metadata row. Answers 204 with no body; a second call is a 404.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9 |
ListDatastore lists the caller org's Hanzo Datastore warehouses.
GET /v1/datastore
ListDatastore lists the caller org's Hanzo Datastore warehouses. Each one is a DEDICATED analytical instance the org alone runs, so the host is that instance's own in-cluster Service and the port is its HTTP port, 8123.
Provision a datastore resource (dedicated per-org instance)
POST /v1/datastore
Request body — application/json
| Field | Type | Required | Description |
|---|---|---|---|
instance | string | — | |
name | string | — |
How is this guide?