hosting

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

Tell us where this site's posts should go.

Všechny koncové body hosting

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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>> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

NázevTypPožadovánoCo to je
siteId (path)stringAno

Tělo požadavku

NázevTypPožadovánoCo to je
kindstring<wordpress, headless_rest, git_static>Ano
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Ne
base_urlstringNe
collectionstringNe
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Ne
auth_headerstringNe
field_mapobjectNe
enabledbooleanNe
secretstringNeThe 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…

Odpověď

NázevTypPožadovánoCo to je
site_idstringAno
kindstring<, wordpress, headless_rest, git_static>AnoEmpty 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>Ano
base_urlstringAnoThe CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
collectionstringAnoThe 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>Ano
auth_headerstringAnoFor the `header` auth scheme — which header the key is sent in.
field_mapobjectAnoRenames, 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…
enabledbooleanAnoA 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_credentialbooleanAno
capabilitiesstring[]Ano
detected_identitystringAnoWhat the destination said it was, last time it answered.
last_probe_atstringAno
last_probe_reachablebooleanAno⛔ `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_codestringAno
last_probe_detailstringAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422