hosting

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

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

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 hosting.deploy.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 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

인증