ai
POST /v1/ai/site-builds/{siteBuildId}/publications
Publish a draft to a destination, taking a backup first when it destroys.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation hosting.deploy.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/ai/site-builds/{siteBuildId}/publications \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "site_id": <Uuid>, "disposition": <SiteMakerDisposition> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Starts a durable publication and returns **202**, not 201: the work has been accepted and is running. A 201 would say the site is published when the backup has not started, and a customer reads "created" as "done". `disposition` decides what happens to whatever is already on the destination: * `add_to` — every existing file is kept byte-for-byte and only new paths are written. A collision is **renamed** (`about.html` becomes `about-new.html`), never merged and never overwritten. * `revamp` — markup, stylesheets and scripts are replaced; content, data files and `robots.txt`, `sitemap.xml`, `.htaccess` and `ads.txt` are kept. A file type we have never seen defaults to kept. * `replace` — the whole tree becomes the draft. **Destructive.** A `replace` requires `confirm_hostname` to equal the site's own primary domain, typed. A boolean flag would be satisfied by any client that set it — including a retry and every future caller that copied the previous request body — so it would confirm that a field exists rather than that a human read the domain. Anything that would overwrite live files takes a **full backup first** and waits for it to finish. That includes a `revamp` that happens to overwrite real pages: the requirement is keyed on what the publication does, not on which word was chosen. A site whose hosting cannot produce a backup is refused rather than published, because we cannot make the change reversible there. One live publication per destination at a time; a second is refused with `409`. Requires `hosting.deploy.manage`, and the target site is scoped by that same authority.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteBuildId (path) | Uuid | Oui | — |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
site_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
disposition | SiteMakerDisposition | Oui | 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… |
confirm_hostname | string | Non | The site's own primary domain, typed by a human. Required for `replace` and compared exactly (case and surrounding space are ignored). ⛔ Not a boolean: a flag is satisfied by an… |
install_plugins | string[] | Non | Slugs from the curated catalogue. Re-vetted server-side; anything else is dropped and counted. The client's list is a request, never an authority. |
include_generated_plugin | boolean | Non | Regenerate and re-scan the custom plugin, and install it if it passes. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
publication | SiteMakerPublication | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 409 · 422 · 429