Docdb
Managed document database (FerretDB / MongoDB wire) — dedicated per-org instance.
Managed document database (FerretDB / MongoDB wire) — dedicated per-org instance.
| Base URL | https://api.hanzo.ai |
| Operations | 4 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
docdb
GetDocDB returns one Hanzo DocDB database's metadata.
GET /v1/docdb/{name}
GetDocDB returns one Hanzo DocDB database's metadata. It carries the database's status, its instance address and the SCRAM user the instance was set up with — never the password. A still-booting instance reads "provisioning", reconciled from the operator's live view.
| 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 |
DropDocDB deprovisions one Hanzo DocDB database.
DELETE /v1/docdb/{name}
DropDocDB deprovisions one Hanzo DocDB database. It reverts any app instance bound to it back to Base BEFORE tearing down the org's dedicated FerretDB 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 |
ListDocDB lists the caller org's Hanzo DocDB document databases.
GET /v1/docdb
ListDocDB lists the caller org's Hanzo DocDB document databases. Each one is a DEDICATED FerretDB instance the org alone runs, speaking the MongoDB wire protocol, so the host is that instance's own in-cluster Service and the port is 27017.
Provision a document-database resource (dedicated per-org instance)
POST /v1/docdb
Request body — application/json
| Field | Type | Required | Description |
|---|---|---|---|
instance | string | — | |
name | string | — |
How is this guide?