GetSQL returns one Hanzo SQL database's metadata.

GET /v1/provisioning/sql/{name}

Provisioning → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/provisioning/sql/{name}`
Method	`GET`
Operation	`get_provisioning_sql_by_name`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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.

Request

1 field.

Field	In	Type	Required	Description
`name`	path	string	yes	Name is the resource's org-unique slug, from the path.

Response

Status	Body	Meaning
`200`	provisionedResource	ok

200 body — 8 fields.

Field	In	Type	Always	Description
`database`	body	string	—	Database is the logical database, collection, index or bucket this resource resolves to on its backend.
`host`	body	string	—	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.
`id`	body	string	—	ID is the resource's server-minted handle, "rs_"-prefixed.
`kind`	body	string	—	Kind is the product: sql, vector, datastore, kv, search, s3 or docdb.
`name`	body	string	—	Name is the org-unique slug the caller provisioned the resource under.
`port`	body	integer	—	Port is the port a client connects to on Host.
`status`	body	string	—	Status is "ready", or "provisioning" while a dedicated instance is still being materialized.
`username`	body	string	—	Username is the credential's user, for the kinds that mint one per resource.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, ProvisioningApi } from 'hanzoai';

const api = new ProvisioningApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProvisioningSqlByName({ name: 'name' });

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_by_name(name='name')

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.ProvisioningAPI.GetProvisioningSqlByName(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::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_by_name(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProvisioningApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new ProvisioningApi(client).getProvisioningSqlByName();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/provisioning/sql/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches provisioning through the provisioning tool, which names its 28 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

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

Provisioning API · All Hanzo APIs · Interactive reference

GetSQL returns one Hanzo SQL database's metadata.

Request

Response

Examples

On this page