Hanzo
OpenapiPlatform

Puts a branch on its own URL.

Puts a branch on its own URL. It deploys an already-built `image` to a per-branch preview and answers its URL, the branch, the preview's slug and the…

POST /v1/platform/projects/{project}/apps/{app}/preview

Addresshttps://api.hanzo.ai/v1/platform/projects/{project}/apps/{app}/preview
MethodPOST
Operationpost_platform_projects_by_project_apps_by_app_preview
AuthAuthorization: Bearer $HANZO_API_KEY

Puts a branch on its own URL.

It deploys an already-built image to a per-branch preview and answers its URL, the branch, the preview's slug and the deployment. The preview is a FIRST-CLASS application named <app>-<branch> in the same project and tenant namespace, with its own default host — so it is completely isolated from production while reusing the same deploy mechanic. Re-previewing a branch converges that same target in place rather than stacking another one.

It carries NO environment variables, deliberately: a preview never inherits production's secrets. It also does not build — image is required and must already exist, and branch defaults to the parent app's. A branch that does not resolve to a valid slug distinct from the parent's is 400. Requires a validated principal; 403 without one.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
projectpathstringyesProject is the project the parent application lives under, from the path.
apppathstringyesApp is the parent application's slug, from the path.
appbodystringApp is the parent application's slug, from the path.
branchbodystringBranch is the branch to preview; defaults to the parent app's branch.
imagebodystringImage is the already-built image ref to deploy.
projectbodystringProject is the project the parent application lives under, from the path.

Response

StatusBodyMeaning
202previewViewaccepted

202 body — 16 fields.

FieldInTypeAlwaysDescription
appbodystringApp is the preview application's own slug, &lt;app&gt;-&lt;branch&gt;.
branchbodystringBranch is the branch this preview maps.
deploymentbodydeploymentView
deployment.applicationIdbodystringApplicationID is the app this deployed — the app's id, not its slug.
deployment.buildIdbodystringBuildID is the build record behind a git deploy, whose logs and status live at /v1/platform/builds.
deployment.commitbodystringCommit is the git ref this built — the commit a deploy or a push named, else the app's branch.
deployment.createdAtbodyintegerCreatedAt is when the attempt was recorded, unix seconds.
deployment.idbodystringID is the deployment's id (dep_…), minted when the attempt is recorded.
deployment.imagebodystringImage is the full repo:tag this deployment put in the CR.
deployment.messagebodystringMessage is why this attempt is not live: the failure, or the note that a newer deployment went live before this build finished.
deployment.orgbodystringOrg is the tenant the deployment belongs to, from the validated identity.
deployment.sourcebodystringSource is which lane produced it: git (built from the repo) or image (an already-built ref deployed as-is, including promote and rollback).
deployment.statusbodystringStatus is where the attempt got to: building while its image is being built, deploying once its CR reached the cluster — which is the terminal success…
deployment.updatedAtbodyintegerUpdatedAt is its last transition, unix seconds — so for a terminal deployment it is when it reached that state.
deployment.versionbodyintegerVersion counts this app's deployments, from 1 and monotonically.
urlbodystringURL is the preview's live HTTPS address.

Failure carries the platform error shape — see Errors.

Examples

hanzo platform projects apps preview <project> <app>

Platform API · All Hanzo APIs · Interactive reference

How is this guide?

On this page