Hanzo
API Reference

Hanzo Provisioning API

Managed-resource control plane (hanzoai/cloud clients/provisioning, HIP-0106).

Managed-resource control plane (hanzoai/cloud clients/provisioning, HIP-0106).

Hanzo Provisioning API · All API references →

Base URLhttps://api.hanzo.ai
Version1.0.0
Operations28

Authentication

  • BearerAuth — HTTP bearer

All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.

curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.ai

Endpoints

datastore

MethodEndpointDescription
GET/v1/datastoreList datastore resources for the caller's org
POST/v1/datastoreProvision a datastore resource (dedicated per-org instance)
GET/v1/datastore/{name}Get one datastore resource (reconciles live instance status)
DELETE/v1/datastore/{name}Deprovision a datastore instance

docdb

MethodEndpointDescription
GET/v1/docdbList document-database resources for the caller's org
POST/v1/docdbProvision a document-database resource (dedicated per-org instance)
GET/v1/docdb/{name}Get one document-database resource (reconciles live instance status)
DELETE/v1/docdb/{name}Deprovision a document-database instance

kv

MethodEndpointDescription
GET/v1/kvList key-value resources for the caller's org
POST/v1/kvProvision a key-value resource
GET/v1/kv/{name}Get one key-value resource
DELETE/v1/kv/{name}Deprovision a key-value resource

s3

MethodEndpointDescription
GET/v1/s3List object-storage buckets for the caller's org
POST/v1/s3Provision an object-storage bucket
GET/v1/s3/{name}Get one object-storage bucket
DELETE/v1/s3/{name}Deprovision an object-storage bucket
MethodEndpointDescription
GET/v1/searchList search resources for the caller's org
POST/v1/searchProvision a search resource
GET/v1/search/{name}Get one search resource
DELETE/v1/search/{name}Deprovision a search resource

sql

MethodEndpointDescription
GET/v1/sqlList SQL resources for the caller's org
POST/v1/sqlProvision a SQL resource
GET/v1/sql/{name}Get one SQL resource
DELETE/v1/sql/{name}Deprovision a SQL resource

vector

MethodEndpointDescription
GET/v1/vectorList vector resources for the caller's org
POST/v1/vectorProvision a vector resource
GET/v1/vector/{name}Get one vector resource
DELETE/v1/vector/{name}Deprovision a vector resource

All Hanzo APIs · OpenAPI spec

How is this guide?

On this page