List sql

Lists the caller org's Hanzo SQL databases.

GET /v1/provisioning/sql

Addresshttps://api.hanzo.ai/v1/provisioning/sql
MethodGET
Operationget_provisioning_sql
AuthAuthorization: Bearer $HANZO_API_KEY

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.

Request

GET /v1/provisioning/sql takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200provisioning.provisionedSummary[]ok
defaultproblem-detailsrefused

200 body — 7 fields.

FieldInTypeAlwaysDescription
[].createdAtbodyinteger (int64)—CreatedAt is when the resource was provisioned, in unix seconds.
[].hostbodystring—Host is the address that actually routes to this resource — a dedicated instance's own in-cluster Service, or the public gateway for a shared one.
[].idbodystring—ID is the resource's server-minted handle, "rs_"-prefixed.
[].kindbodystring—Kind is the product: sql, vector, datastore, kv, search, s3 or docdb.
[].namebodystring—Name is the org-unique slug the caller provisioned the resource under.
[].portbodyinteger (int64)—Port is the port a client connects to on Host.
[].statusbodystring—Status is "ready", or "provisioning" while a dedicated instance is still being materialized by the operator.

Failure carries the platform error shape — see Errors.

Examples

hanzo provisioning sql list
import { Configuration, ProvisioningApi } from 'hanzoai';

const api = new ProvisioningApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProvisioningSql();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProvisioningApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProvisioningApi(client).get_provisioning_sql()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ProvisioningAPI.GetProvisioningSql(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, provisioning_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = provisioning_api::get_provisioning_sql(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProvisioningApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new ProvisioningApi(client).getProvisioningSql();
curl https://api.hanzo.ai/v1/provisioning/sql \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool provisioning, op get_provisioning_sql — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "provisioning",
         "arguments": {
           "op": "get_provisioning_sql",
           "input": {}
         }
       }
     }'

Provisioning API · All Hanzo APIs · Interactive reference

Was this page useful?