hosting

PUT /v1/sites/{siteId}/cms-target

Tell us where this site's posts should go.

Toate punctele finale hosting

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cms-target \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "kind": <string<wordpress, headless_rest, git_static>> }'

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

Creates or replaces the site's content target. Gated on `links.edit`. ⛔ `secret` is write-only, and **omitting it keeps the credential you already have** rather than clearing it — a customer editing a collection name must not silently delete their key. The secret is written to Vault **before** the row is saved, and the row is only written if that succeeded: the other order leaves a row that reads as configured on every screen and fails at the first publish.

Parametri

NumeTipObligatoriuCe este
siteId (path)stringDa

Corp cerere

NumeTipObligatoriuCe este
kindstring<wordpress, headless_rest, git_static>Da
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Nu
base_urlstringNu
collectionstringNu
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Nu
auth_headerstringNu
field_mapobjectNu
enabledbooleanNu
secretstringNuThe API key. ⛔ Write-only, and **omitting it keeps the credential you already have** rather than clearing it. It is written to Vault before the row is saved, and the row is only…

Răspuns

NumeTipObligatoriuCe este
site_idstringDa
kindstring<, wordpress, headless_rest, git_static>DaEmpty when nothing claims this site. For a site with no configured row this is the **derived** target — most WordPress sites on our own fleet need no configuration at all, becau…
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Da
base_urlstringDaThe CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
collectionstringDaThe collection posts are created in — `posts` on Payload, a blog id on Shopify, a collection id on Webflow, the content directory on a Git target.
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Da
auth_headerstringDaFor the `header` auth scheme — which header the key is sent in.
field_mapobjectDaRenames, for a destination that spells our fields differently. ⛔ It **renames**; it never adds a capability. A field map cannot make a target able to carry a tag it has no field…
enabledbooleanDaA disabled target is skipped and reads as `needs_setup` — kept rather than deleted so pausing publishing to a site does not lose its set-up.
has_credentialbooleanDa
capabilitiesstring[]Da
detected_identitystringDaWhat the destination said it was, last time it answered.
last_probe_atstringDa
last_probe_reachablebooleanDa⛔ `null` means **never probed**; `false` means probed and could not be reached. Those are different facts and a client must not render them the same.
last_probe_codestringDa
last_probe_detailstringDa

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422