hosting

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

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

ప్రమాణీకరణ

బీయర్ టోకెన్‌గా API కీని పంపండి. కీ తప్పనిసరిగా hosting.deploy.manage అనుమతిని కలిగి ఉండాలి; అది లేని కీని 404 కాకుండా 403తో తిరస్కరిస్తారు.

ఈ ఎండ్‌పాయింట్ ఎలాంటి సంస్థ ఐడీని తీసుకోదు. మీ కీ ఇప్పటికే అది ఏ సంస్థకు చెందుతుందో గుర్తిస్తుంది మరియు ప్రతిస్పందన దానికే పరిమితం చేయబడుతుంది.

ప్రయత్నించండి

కోణీయ బ్రాకెట్‌లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్‌హోల్డర్‌ను మీ డాష్‌బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.

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