hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão hosting.deploy.manage; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
A preview NEVER binds the site's hostname: it is reachable at the provider's own per-deployment URL and nowhere else, which is the whole promise of a preview. Previewing the branch the site already serves is refused rather than quietly promoted to a production deploy. Requires `hosting.deploy.manage`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
branch | string | Sim | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | Sim | Where 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 on… |
status | DeployStatus | Sim | `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. |
trigger | DeployTrigger | Sim | What caused the deploy. Stored because `requested_by` cannot answer it for a push — the actor there is a webhook delivery, not a person. |
repo | object | Sim | — |
branch | object | Sim | — |
commit | object | Sim | — |
commit_message | object | Sim | — |
live_url | object | Sim | — |
message | object | Sim | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | Sim | — |
created_at | string | Sim | — |
started_at | object | Sim | — |
finished_at | object | Sim | — |
log | string | Sim | The build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 409 · 422 · 429 · 503