hosting

POST `/v1/sites/{siteId}/previews`

Build a branch as a preview, without touching the live site.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה hosting.deploy.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "branch": <string> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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`.

פרמטרים

שם	סוג	נדרש	מה זה
`siteId (path)`	`Uuid`	כן	Site ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`branch`	`string`	כן	The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy.

תשובה

שם	סוג	נדרש	מה זה
`id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`target`	`DeployTarget`	כן	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`	כן	`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`	כן	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`	כן	—
`branch`	`object`	כן	—
`commit`	`object`	כן	—
`commit_message`	`object`	כן	—
`live_url`	`object`	כן	—
`message`	`object`	כן	Why it failed, else null. Rendered to the customer verbatim.
`requested_by`	`string`	כן	—
`created_at`	`string`	כן	—
`started_at`	`object`	כן	—
`finished_at`	`object`	כן	—
`log`	`string`	כן	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.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 409 · 422 · 429 · 503

POST /v1/sites/{siteId}/previews