hosting

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

Tell us where this site's posts should go.

Усі кінцеві точки hosting

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

НазваТипОбов'язковеЩо це таке
siteId (path)stringТак

Тіло запиту

НазваТипОбов'язковеЩо це таке
kindstring<wordpress, headless_rest, git_static>Так
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Ні
base_urlstringНі
collectionstringНі
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Ні
auth_headerstringНі
field_mapobjectНі
enabledbooleanНі
secretstringНіThe 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…

Відповідь

НазваТипОбов'язковеЩо це таке
site_idstringТак
kindstring<, wordpress, headless_rest, git_static>ТакEmpty 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>Так
base_urlstringТакThe CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
collectionstringТакThe 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>Так
auth_headerstringТакFor the `header` auth scheme — which header the key is sent in.
field_mapobjectТакRenames, 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…
enabledbooleanТакA 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_credentialbooleanТак
capabilitiesstring[]Так
detected_identitystringТакWhat the destination said it was, last time it answered.
last_probe_atstringТак
last_probe_reachablebooleanТак⛔ `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_codestringТак
last_probe_detailstringТак

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422