Hanzo
OpenapiPlatform

Returns one deployment of one app.

Returns one deployment of one app. It returns a single deployment by id, scoped to the named application of the caller's org — so an id belonging to…

GET /v1/platform/projects/{project}/apps/{app}/deployments/{id}

Addresshttps://api.hanzo.ai/v1/platform/projects/{project}/apps/{app}/deployments/{id}
MethodGET
Operationget_platform_projects_by_project_apps_by_app_deployments_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one deployment of one app.

It returns a single deployment by id, scoped to the named application of the caller's org — so an id belonging to another app or another tenant is 404, not a read. Requires a validated principal; 403 without one.

Request

3 fields.

FieldInTypeRequiredDescription
projectpathstringyesProject is the project the application lives under, from the path.
apppathstringyesApp is the application's slug, from the path.
idpathstringyesID is the deployment's id, from the path.

Response

StatusBodyMeaning
200deploymentViewok

200 body — 12 fields.

FieldInTypeAlwaysDescription
applicationIdbodystringApplicationID is the app this deployed — the app's id, not its slug.
buildIdbodystringBuildID is the build record behind a git deploy, whose logs and status live at /v1/platform/builds.
commitbodystringCommit is the git ref this built — the commit a deploy or a push named, else the app's branch.
createdAtbodyintegerCreatedAt is when the attempt was recorded, unix seconds.
idbodystringID is the deployment's id (dep_…), minted when the attempt is recorded.
imagebodystringImage is the full repo:tag this deployment put in the CR.
messagebodystringMessage is why this attempt is not live: the failure, or the note that a newer deployment went live before this build finished.
orgbodystringOrg is the tenant the deployment belongs to, from the validated identity.
sourcebodystringSource is which lane produced it: git (built from the repo) or image (an already-built ref deployed as-is, including promote and rollback).
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…
updatedAtbodyintegerUpdatedAt is its last transition, unix seconds — so for a terminal deployment it is when it reached that state.
versionbodyintegerVersion counts this app's deployments, from 1 and monotonically.

Failure carries the platform error shape — see Errors.

Examples

hanzo platform projects apps deployments get <project> <app> <id>

Platform API · All Hanzo APIs · Interactive reference

How is this guide?

On this page