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}/deploy \
-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
A site that has never been deployed reports status `idle` with null details — null means "nothing to show", never zero or an epoch. This is polled while a deploy is in flight, so it is a cheap database read and never calls a build provider. Requires `sites.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | Yes | Null when no target can be derived yet. |
status | DeployStatus | Yes | `idle` 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. |
last_deployed_at | object | Yes | When the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date. |
live_url | object | Yes | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | Yes | Source repository for the Pages targets, else null. |
commit | object | Yes | The deployed commit ref, else null. |
message | object | Yes | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | Yes | False while a deploy is in flight or the site cannot be deployed. |
Errors this endpoint can return
401 · 403 · 404 · 429