CreateSQL launches your org's OWN PostgreSQL instance and answers with its…
CreateSQL launches your org's OWN PostgreSQL instance and answers with its `postgres://` connection string.
POST /v1/provisioning/sql
| Address | https://api.hanzo.ai/v1/provisioning/sql |
| Method | POST |
| Operation | post_provisioning_sql |
| Auth | Authorization: Bearer $HANZO_API_KEY |
CreateSQL launches your org's OWN PostgreSQL instance and answers with its
postgres:// connection string.
The instance is yours alone — a deployment in your own tenant namespace, so its admin credential is naturally scoped to you and no other tenant shares the process. Off-cluster, where there is no orchestrator to launch one, this fails closed with 503 rather than handing back a shared one.
Request
2 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
instance | body | string | — | Instance binds a DEDICATED add-on to the app instance whose <instance>-addons Secret receives the <KIND>_URL (e.g. "commerce"). |
name | body | string | — | Name is the org-unique slug for the new resource, matching ^a-z0-9?$. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | provisionResult | created |
201 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
connectionString | body | string | — | ConnectionString is the ready-to-use DSN, credential included. |
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 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 provisioned: sql, vector, datastore, kv, search, s3 or docdb. |
name | body | string | — | Name is the org-unique slug the caller asked for, lower-cased. |
password | body | string | — | Password is the minted credential, in plaintext, for the kinds that have one. |
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 by the operator. |
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.postProvisioningSql({ instance: "<instance>", 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).post_provisioning_sql(instance="<instance>", name="<name>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.ProvisioningAPI.PostProvisioningSql(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::post_provisioning_sql(&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).postProvisioningSql();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 -X POST https://api.hanzo.ai/v1/provisioning/sql \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance": "<instance>",
"name": "<name>"
}'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"
}
}
}'How is this guide?