Hanzo
OpenapiProjects

Returns one deployment of a project by id.

Returns one deployment of a project by id.

GET /v1/projects/{slug}/deployments/{id}

Addresshttps://api.hanzo.ai/v1/projects/{slug}/deployments/{id}
MethodGET
Operationget_projects_by_slug_deployments_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one deployment of a project by id.

It is how a console follows a build: the status (queued, uploading, live, error), the message a failure left, and the URL and prefix it went live at. Like the history, it never replays the upload grant.

Scope: a validated principal is required (403 without one). Both the project and the deployment are resolved within that principal's org, so a deployment of another project — or of another tenant — is a 404.

Request

2 fields.

FieldInTypeRequiredDescription
slugpathstringyesSlug is the project the deployment belongs to, from the path.
idpathstringyesID is the deployment id, from the path.

Response

StatusBodyMeaning
200projectsDeploymentok

200 body — 21 fields.

FieldInTypeAlwaysDescription
bucketbodystringBucket is the object-store bucket its files were written to.
bytesbodyintegerBytes is their total size in bytes.
commitbodystringCommit is the revision that was built, for a deployment that came from a repository.
createdAtbodyintegerCreatedAt is when the deployment was queued, as Unix seconds.
filesbodyintegerFiles is how many objects the deployment published.
idbodystringID identifies this one deployment attempt, and is what CI quotes back to complete it.
liveUrlbodystringLiveURL is where this deployment serves, once it is live.
messagebodystringMessage is what happened, in words — the build's own note, or on a failure why it failed.
prefixbodystringPrefix is the key prefix within that bucket holding EXACTLY this deployment's objects — the unit an upload grant is scoped to, so a grant for one deployment…
projectIdbodystringProjectID is the project this deployment belongs to.
sourcebodystringSource is what caused the deployment — a git push, an uploaded artifact, a generated site.
statusbodystringStatus is where the attempt got to — queued, live, or failed.
updatedAtbodyintegerUpdatedAt is when it last changed state, as Unix seconds — so the gap between the two is how long the build took.
uploadbodyprojectsUploadGrant
upload.expiresAtbodyintegerExpiresAt is when the grant stops being accepted, as Unix seconds.
upload.fieldsbodyobjectFields are form values every POST must carry VERBATIM, alongside key and file.
upload.fields.*bodystring
upload.maxBytesbodyintegerMaxBytes bounds ONE object, not the upload as a whole.
upload.prefixbodystringPrefix is the only place this grant can write: the deployment's own key prefix.
upload.urlbodystringURL is the address to POST each object to.
versionbodyintegerVersion counts deployments of this project from 1, so the history reads as an ordered sequence rather than by timestamp.

Failure carries the platform error shape — see Errors.

Examples

hanzo projects deployments get <slug> <id>

Projects API · All Hanzo APIs · Interactive reference

How is this guide?

On this page