hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar hosting.deploy.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
siteId (path) | Uuid | Evet | Site ID (UUIDv7). |
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
branch | string | Evet | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | Evet | 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 | Evet | `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 | Evet | 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 | Evet | — |
branch | object | Evet | — |
commit | object | Evet | — |
commit_message | object | Evet | — |
live_url | object | Evet | — |
message | object | Evet | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | Evet | — |
created_at | string | Evet | — |
started_at | object | Evet | — |
finished_at | object | Evet | — |
log | string | Evet | 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. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 409 · 422 · 429 · 503