hosting

POST /v1/sites/{siteId}/previews

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

Све hosting крајње тачке

Сва документација за програмере →

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу 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).

Тело захтева

НазивТипОбавезноШта је ово
branchstringДаThe branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy.

Одговор

НазивТипОбавезноШта је ово
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTargetДа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 one.…
statusDeployStatusДа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.
triggerDeployTriggerДаWhat caused the deploy. Stored because requested_by cannot answer it for a push — the actor there is a webhook delivery, not a person.
repoobjectДа—
branchobjectДа—
commitobjectДа—
commit_messageobjectДа—
live_urlobjectДа—
messageobjectДаWhy it failed, else null. Rendered to the customer verbatim.
requested_bystringДа—
created_atstringДа—
started_atobjectДа—
finished_atobjectДа—
logstringДа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