API Reference
Hanzo PaaS API
Production PaaS for Hanzo Platform — K8s-native GitOps deployments,
Production PaaS for Hanzo Platform — K8s-native GitOps deployments,
bearerAuth — HTTP bearerBearerAuth — 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://paas.hanzo.ai
| Method | Endpoint | Description |
|---|
POST | /v1/paas/auth/login | Login via IAM |
GET | /v1/paas/auth/me | Get current user |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/cluster/setup-status | Check cluster setup status |
GET | /v1/paas/cluster/info | Get cluster info |
GET | /v1/paas/cluster/domains | List cluster domains |
POST | /v1/paas/cluster/domains | Add cluster domain |
DELETE | /v1/paas/cluster/domains/{domain} | Remove cluster domain |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers | List containers |
POST | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers | Create container |
GET | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers/{containerId} | Get container |
PUT | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers/{containerId} | Update container |
DELETE | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers/{containerId} | Delete container |
POST | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers/{containerId}/deploy | Trigger deployment (Nixpacks build + deploy) |
GET | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers/{containerId}/pods | List container pods |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/cluster/doks/fleet | Fleet overview (all org clusters) |
GET | /v1/paas/cluster/doks/options | Available regions and node sizes |
GET | /v1/paas/cluster/doks/pricing/{sizeSlug} | Get droplet pricing |
POST | /v1/paas/cluster/doks/provision | Provision new DOKS cluster for org |
GET | /v1/paas/cluster/doks/{orgId}/status | Get cluster status (polls DO API) |
GET | /v1/paas/cluster/doks/{orgId}/kubeconfig | Download kubeconfig |
GET | /v1/paas/cluster/doks/{orgId}/node-pools | List node pools |
POST | /v1/paas/cluster/doks/{orgId}/node-pools | Add node pool |
PUT | /v1/paas/cluster/doks/{orgId}/node-pools/{poolId} | Update node pool |
DELETE | /v1/paas/cluster/doks/{orgId}/node-pools/{poolId} | Delete node pool |
POST | /v1/paas/cluster/doks/{orgId}/upgrade-ha | Upgrade to HA control plane |
DELETE | /v1/paas/cluster/doks/{orgId} | Destroy DOKS cluster |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/org/{orgId}/project/{projectId}/env | List environments |
POST | /v1/paas/org/{orgId}/project/{projectId}/env | Create environment |
GET | /v1/paas/org/{orgId}/project/{projectId}/env/{envId} | Get environment |
DELETE | /v1/paas/org/{orgId}/project/{projectId}/env/{envId} | Delete environment |
| Method | Endpoint | Description |
|---|
GET | /health | Health check |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/org/{orgId}/project/{projectId}/env/{envId}/containers/{containerId}/logs | Get container logs |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/org | List organizations |
POST | /v1/paas/org | Create organization |
GET | /v1/paas/org/{orgId} | Get organization |
PUT | /v1/paas/org/{orgId} | Update organization |
DELETE | /v1/paas/org/{orgId} | Delete organization |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/org/{orgId}/project | List projects |
POST | /v1/paas/org/{orgId}/project | Create project |
GET | /v1/paas/org/{orgId}/project/{projectId} | Get project |
PUT | /v1/paas/org/{orgId}/project/{projectId} | Update project |
DELETE | /v1/paas/org/{orgId}/project/{projectId} | Delete project |
| Method | Endpoint | Description |
|---|
GET | /v1/paas/system/templates | List available templates |
Hanzo PaaS API guide · All Hanzo APIs · OpenAPI spec
How is this guide?