POST `/v1/ai/site-builds/{siteBuildId}/preview`

What publishing this draft would do to that site. Changes nothing.

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie hosting.deploy.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X POST https://api.zinndigital.com/v1/ai/site-builds/{siteBuildId}/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": <Uuid>, "disposition": <SiteMakerDisposition> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

Answers "what happens if the site is already there" before anything happens: which existing files are kept, which are added, which would be **overwritten**, and which generated files would be renamed to avoid a collision. This runs the same guard the publication itself runs, not a second description of it. A preview computed by different code is a promise the real path never made, and it would be wrong in exactly the cases that matter. The preview does **not** require the typed confirmation that a `replace` needs. A customer has to be able to see what would be destroyed before deciding to confirm it; demanding the confirmation in order to show the consequence is the wrong way round. Requires `hosting.deploy.manage`.

Parameters

Naam	Type	Verplicht	Wat dit is
`siteBuildId (path)`	`Uuid`	Ja	—

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`site_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`disposition`	`SiteMakerDisposition`	Ja	What to do with what is already on the destination. `add_to` keeps every existing byte, `revamp` replaces presentation and keeps content, `replace` is destructive and requires a…

Reactie

Naam	Type	Verplicht	Wat dit is
`preview`	`SiteMakerPreview`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429

POST /v1/ai/site-builds/{siteBuildId}/preview