hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen hosting.deploy.manage; një çelës pa të refuzohet me 403, jo 404.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
siteId (path) | Uuid | Po | Site ID (UUIDv7). |
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
branch | string | Po | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | Po | 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 | Po | `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 | Po | 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 | Po | — |
branch | object | Po | — |
commit | object | Po | — |
commit_message | object | Po | — |
live_url | object | Po | — |
message | object | Po | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | Po | — |
created_at | string | Po | — |
started_at | object | Po | — |
finished_at | object | Po | — |
log | string | Po | 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. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 409 · 422 · 429 · 503