API Reference
Hanzo Platform API
PaaS API for Hanzo Platform (platform.hanzo.ai) — deployments,
PaaS API for Hanzo Platform (platform.hanzo.ai) — deployments,
BearerAuth — HTTP bearerApiKeyAuth — API key in header (X-API-Key)
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://platform.hanzo.ai
| Method | Endpoint | Description |
|---|
POST | /v1/platform/ai/suggest | Get AI deployment suggestions |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/application/create | Create a new application |
GET | /v1/platform/application/one | Get application details |
POST | /v1/platform/application/delete | Delete an application and all associated resources |
POST | /v1/platform/application/update | Update application configuration |
POST | /v1/platform/application/start | Start a stopped application |
POST | /v1/platform/application/stop | Stop a running application |
POST | /v1/platform/application/reload | Reload application container (re-mechanize) |
POST | /v1/platform/application/deploy | Trigger a new deployment |
POST | /v1/platform/application/redeploy | Redeploy (rebuild) an application |
POST | /v1/platform/application/cancelDeployment | Cancel an in-progress deployment |
POST | /v1/platform/application/saveEnvironment | Save environment variables and build args |
POST | /v1/platform/application/saveBuildType | Configure the build type |
POST | /v1/platform/application/saveGithubProvider | Configure GitHub as source provider |
POST | /v1/platform/application/saveGitlabProvider | Configure GitLab as source provider |
POST | /v1/platform/application/saveBitbucketProvider | Configure Bitbucket as source provider |
POST | /v1/platform/application/saveGiteaProvider | Configure Gitea as source provider |
POST | /v1/platform/application/saveDockerProvider | Configure Docker image as source |
POST | /v1/platform/application/saveGitProdiver | Configure custom Git URL as source |
POST | /v1/platform/application/disconnectGitProvider | Disconnect all git providers from application |
POST | /v1/platform/application/refreshToken | Regenerate webhook refresh token |
GET | /v1/platform/application/readTraefikConfig | Read Traefik routing config for an application |
POST | /v1/platform/application/updateTraefikConfig | Write Traefik routing config |
GET | /v1/platform/application/readAppMonitoring | Read container monitoring stats |
POST | /v1/platform/application/move | Move application to a different environment |
POST | /v1/platform/application/markRunning | Mark application status as running |
POST | /v1/platform/application/cleanQueues | Clear pending deployment jobs |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/backup/create | Create a backup schedule |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/billing/getPlans | List subscription plans |
GET | /v1/platform/billing/getBalance | Get account balance |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/certificates/all | List SSL certificates (admin) |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/cluster/getNodes | List Docker Swarm nodes |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/compose/create | Create a Docker Compose service |
GET | /v1/platform/compose/one | Get compose service details |
POST | /v1/platform/compose/update | Update compose configuration |
POST | /v1/platform/compose/delete | Delete a compose service |
POST | /v1/platform/compose/deploy | Deploy a compose service |
POST | /v1/platform/compose/redeploy | Redeploy (rebuild) a compose service |
POST | /v1/platform/compose/stop | Stop a compose service |
POST | /v1/platform/compose/start | Start a compose service |
POST | /v1/platform/compose/cancelDeployment | Cancel in-progress compose deployment |
GET | /v1/platform/compose/loadServices | List running services within a compose stack |
GET | /v1/platform/compose/templates | List available one-click templates |
POST | /v1/platform/compose/deployTemplate | Deploy a one-click template |
POST | /v1/platform/compose/move | Move compose to a different environment |
POST | /v1/platform/compose/refreshToken | Regenerate webhook token |
GET | /v1/platform/compose/getConvertedCompose | Get final compose YAML with domains injected |
GET | /v1/platform/compose/getDefaultCommand | Get the docker compose command |
POST | /v1/platform/compose/disconnectGitProvider | Disconnect git providers from compose |
GET | /v1/platform/compose/getTags | Get unique tags from all templates |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/deploy | Submit deployment job to worker queue |
POST | /v1/platform/cancel-deployment | Cancel an in-progress worker deployment |
GET | /health | Deploy worker health check |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/deployment/all | List deployments for an application |
GET | /v1/platform/deployment/allByCompose | List deployments for a compose service |
GET | /v1/platform/deployment/allByServer | List deployments on a server |
GET | /v1/platform/deployment/allByType | List deployments by resource type and ID |
POST | /v1/platform/deployment/killProcess | Kill a running deployment process |
POST | /v1/platform/deploy/{refreshToken} | Webhook to trigger application deployment |
POST | /v1/platform/deploy/compose/{refreshToken} | Webhook to trigger compose deployment |
POST | /v1/platform/deploy/github | GitHub webhook receiver for auto-deploy |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/destination/all | List backup destinations |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/docker/getContainers | List all Docker containers |
POST | /v1/platform/docker/restartContainer | Restart a container by ID |
GET | /v1/platform/docker/getConfig | Get Docker inspect for a container |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/domain/create | Create a domain mapping |
GET | /v1/platform/domain/one | Get a domain by ID |
GET | /v1/platform/domain/byApplicationId | List domains for an application |
GET | /v1/platform/domain/byComposeId | List domains for a compose service |
POST | /v1/platform/domain/update | Update a domain mapping |
POST | /v1/platform/domain/delete | Delete a domain |
POST | /v1/platform/domain/generateDomain | Generate a traefik.me auto-domain |
POST | /v1/platform/domain/validateDomain | Validate DNS for a domain |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/environment/create | Create a new environment within a project |
GET | /v1/platform/environment/one | Get a single environment by ID |
GET | /v1/platform/environment/byProjectId | List all environments for a project |
POST | /v1/platform/environment/remove | Delete an environment |
POST | /v1/platform/environment/update | Update an environment |
POST | /v1/platform/environment/duplicate | Duplicate an environment with all services |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/gitProvider/getAll | List all git providers |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/github/githubProviders | List GitHub installations |
GET | /v1/platform/github/getGithubRepositories | List repos from a GitHub installation |
GET | /v1/platform/github/getGithubBranches | List branches for a repository |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/mariadb/create | Create a MariaDB service |
GET | /v1/platform/mariadb/one | Get MariaDB details |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/mongo/create | Create a MongoDB service |
GET | /v1/platform/mongo/one | Get MongoDB details |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/mysql/create | Create a MySQL service |
GET | /v1/platform/mysql/one | Get MySQL details |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/notification/all | List notification channels (admin) |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/organization/create | Create an organization |
GET | /v1/platform/organization/all | List organizations |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/postgres/create | Create a PostgreSQL service |
GET | /v1/platform/postgres/one | Get PostgreSQL details |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/project/create | Create a new project |
GET | /v1/platform/project/one | Get a single project by ID |
GET | /v1/platform/project/all | List all projects in the active organization |
POST | /v1/platform/project/remove | Delete a project |
POST | /v1/platform/project/update | Update a project |
POST | /v1/platform/project/duplicate | Duplicate a project or environment with selected services |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/redis/create | Create a Redis service |
GET | /v1/platform/redis/one | Get Redis details |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/registry/all | List container registries |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/rollback/rollback | Rollback to a previous deployment |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/schedule/list | List scheduled tasks |
POST | /v1/platform/schedule/create | Create a scheduled task |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/server/create | Register a new remote server |
GET | /v1/platform/server/one | Get server details |
GET | /v1/platform/server/all | List all servers with service counts |
POST | /v1/platform/server/remove | Remove a server (must have no active services) |
POST | /v1/platform/server/update | Update server configuration |
POST | /v1/platform/server/setup | Run initial setup (install Docker, Traefik, etc.) |
GET | /v1/platform/server/validate | Validate server capabilities |
GET | /v1/platform/server/security | Run security audit (ufw, ssh, fail2ban) |
POST | /v1/platform/server/setupMonitoring | Configure and deploy monitoring agent |
GET | /v1/platform/server/getServerMetrics | Fetch server metrics (CPU, memory, disk, network) |
GET | /v1/platform/server/publicIp | Get platform host public IP |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/settings/health | Platform health check (tRPC) |
GET | /v1/platform/settings/isCloud | Check if running in cloud mode |
GET | /v1/platform/settings/getHanzoVersion | Get platform version |
POST | /v1/platform/settings/reloadTraefik | Reload Traefik configuration (admin) |
POST | /v1/platform/settings/cleanAll | Full Docker cleanup (admin) |
GET | /v1/platform/health | Platform health (REST) |
GET | /v1/platform/healthcheck | Platform healthcheck (REST) |
| Method | Endpoint | Description |
|---|
POST | /v1/platform/sshKey/create | Add an SSH key |
GET | /v1/platform/sshKey/all | List all SSH keys |
POST | /v1/platform/sshKey/generate | Generate a new SSH key pair |
POST | /v1/platform/sshKey/remove | Remove an SSH key |
| Method | Endpoint | Description |
|---|
GET | /v1/platform/user/get | Get current authenticated user |
GET | /v1/platform/user/all | List all users (admin only) |
POST | /v1/platform/user/createApiKey | Create an API key |
POST | /v1/platform/user/deleteApiKey | Delete an API key |
Hanzo Platform API guide · All Hanzo APIs · OpenAPI spec
How is this guide?