hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění hosting.deploy.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
branch | string | Ano | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | Ano | 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 | Ano | `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 | Ano | 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 | Ano | — |
branch | object | Ano | — |
commit | object | Ano | — |
commit_message | object | Ano | — |
live_url | object | Ano | — |
message | object | Ano | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | Ano | — |
created_at | string | Ano | — |
started_at | object | Ano | — |
finished_at | object | Ano | — |
log | string | Ano | 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. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 409 · 422 · 429 · 503