Hanzo

Sql

Managed SQL (Postgres) database resources.

Managed SQL (Postgres) database resources.

Base URLhttps://api.hanzo.ai
Operations4
AuthAuthorization: Bearer $HANZO_API_KEY

sql

GetSQL returns one Hanzo SQL database's metadata.

GET /v1/sql/{name}

GetSQL returns one Hanzo SQL database's metadata. It carries the database's status, its instance address and the admin user Postgres booted with — never the password, which is returned once at create and otherwise lives only in Hanzo KMS. A still-booting instance reads "provisioning", reconciled from the operator's live view rather than from the row.

ParameterInTypeRequiredDescription
namepathstringyesThe user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9

DropSQL deprovisions one Hanzo SQL database.

DELETE /v1/sql/{name}

DropSQL deprovisions one Hanzo SQL database. It reverts any app instance bound to it back to Base BEFORE tearing down the org's dedicated Postgres instance — never a live app pointed at a deleted backend — then deletes the sealed credential and removes the metadata row. Answers 204 with no body; a second call is a 404, not a second delete.

ParameterInTypeRequiredDescription
namepathstringyesThe user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9

ListSQL lists the caller org's Hanzo SQL databases.

GET /v1/sql

ListSQL lists the caller org's Hanzo SQL databases. Each one is a DEDICATED PostgreSQL instance the org alone runs, so the host is that instance's own in-cluster Service and the port is 5432.

Provision a SQL resource

POST /v1/sql

Request bodyapplication/json

FieldTypeRequiredDescription
instancestring
namestring

Sql guide · All Hanzo APIs · Interactive reference

How is this guide?

On this page