Hanzo
OpenapiPlatform

Rolls a platform service's pods, in a named environment.

Rolls a platform service's pods, in a named environment.

POST /v1/platform/fleet/{app}/deploy

Addresshttps://api.hanzo.ai/v1/platform/fleet/{app}/deploy
MethodPOST
Operationpost_platform_fleet_by_app_deploy
AuthAuthorization: Bearer $HANZO_API_KEY

Rolls a platform service's pods, in a named environment.

It triggers a rolling restart of one platform service's Deployment by stamping a fresh restart annotation, and answers 202 with the app, the namespace, the environment and the timestamp. It restarts pods; it does NOT change the image — a version change is the release path, not this.

SuperAdmin ONLY, and deliberately narrower than the read gate beside it. The only namespaces this board touches are the platform's own tier, so a restart here recycles a SHARED service every tenant depends on. A brand-org admin is a customer-org admin, not a platform operator: observing the board is bounded and audited, and restarting production identity is not.

?env=main|test|dev is REQUIRED — a bare call does not default to production, which is what closes the fat-finger and confused-deputy hazard — and any other value is 400. A service with no Deployment to restart in that environment is 404.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
apppathstringyesApp is the service's CR name, from the path.
appbodystringApp is the service's CR name, from the path.
envbodystringEnv is REQUIRED and must be main, test or dev. A bare call does not default to production, which is what closes the fat-finger and confused-deputy hazard.

Response

StatusBodyMeaning
202restartedaccepted

202 body — 5 fields.

FieldInTypeAlwaysDescription
appbodystringApp is the service that was restarted.
envbodystringEnv is that namespace's lifecycle env.
namespacebodystringNamespace is the namespace its Deployment was patched in.
okbodybooleanOK is always true — a failure is an error, not a false here.
restartedAtbodystringRestartedAt is the timestamp stamped onto the pod template, RFC3339 UTC.

Failure carries the platform error shape — see Errors.

Examples

hanzo platform fleet deploy <app>

Platform API · All Hanzo APIs · Interactive reference

How is this guide?

On this page