Get s3

Returns one bucket's metadata.

GET /v1/provisioning/s3/{name}

Provisioning → · All API references → · Get started →

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

Returns one bucket's metadata. It carries the bucket's status and the gateway address it is reached at, and no username: the object store authenticates with a shared, out-of-band key rather than a per-bucket credential.

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`	provisioning.provisionedResource	ok
`default`	problem-details	refused

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 (int64)	—	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

CLI

SDK

HTTP

MCP

hanzo provisioning s3 get <name>

.ts

.py

.go

.rs

.java

import { Configuration, ProvisioningApi } from 'hanzoai';

const api = new ProvisioningApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProvisioningS3ByName({ 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_s3_by_name(name='name')

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

resp, _, err := client.ProvisioningAPI.GetProvisioningS3ByName(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_s3_by_name(&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).getProvisioningS3ByName();

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

Tool provisioning, op get_provisioning_s3_by_name — 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_s3_by_name",
           "input": {
             "name": "<name>"
           }
         }
       }
     }'

Provisioning API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList kv NextList s3