hosting

GET /v1/sites/{siteId}/deployments/{deploymentId}

One deploy, with its build log.

All hosting endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deployments/{deploymentId} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The log is written line by line as the build runs rather than at the end, so it is readable while a deploy is in flight and present on one that hangs. Requires sites.view.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).
deploymentId (path)UuidYesDeployment ID (UUIDv7).

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTargetYesWhere the site is published from. fleet is our own managed fleet; the rest are managed edge hosts, deployed to from a pooled account of ours or the customer's own connected one.…
statusDeployStatusYesidle means the site has never been deployed. It is reported, never stored — a stored idle would be a second way to say "no deployments" that could contradict the first.
triggerDeployTriggerYesWhat caused the deploy. Stored because requested_by cannot answer it for a push — the actor there is a webhook delivery, not a person.
repoobjectYes—
branchobjectYes—
commitobjectYes—
commit_messageobjectYes—
live_urlobjectYes—
messageobjectYesWhy it failed, else null. Rendered to the customer verbatim.
requested_bystringYes—
created_atstringYes—
started_atobjectYes—
finished_atobjectYes—
logstringYesThe build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is.

Errors this endpoint can return

401 · 403 · 404 · 429