Hanzo
OpenapiProjects

Returns a project's deploy history, newest version first.

Returns a project's deploy history, newest version first.

GET /v1/projects/{slug}/deployments

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

Returns a project's deploy history, newest version first.

Every deploy of the project is a row — uploads, generated sites, and git/CI builds alike — carrying its version, status, source, commit, live URL, file count and byte count. The short-lived upload grant a queued git deployment was handed is NOT replayed here: it exists only on the 202 that minted it, so a grant cannot outlive its build by being fetched again.

Scope: a validated principal is required (403 without one) and the project is resolved within that principal's org, so another tenant's slug is a 404.

Request

1 field.

FieldInTypeRequiredDescription
slugpathstringyesSlug is the project to act on, from the path.

Response

StatusBodyMeaning
200projectsDeployment[]ok

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 list <slug>

Projects API · All Hanzo APIs · Interactive reference

How is this guide?

On this page