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 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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