hosting

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

Tell us where this site's posts should go.

Tüm hosting uç noktaları

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

AdTürZorunluNe olduğu
siteId (path)stringEvet

İstek gövdesi

AdTürZorunluNe olduğu
kindstring<wordpress, headless_rest, git_static>Evet
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Hayır
base_urlstringHayır
collectionstringHayır
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Hayır
auth_headerstringHayır
field_mapobjectHayır
enabledbooleanHayır
secretstringHayırThe 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…

Yanıt

AdTürZorunluNe olduğu
site_idstringEvet
kindstring<, wordpress, headless_rest, git_static>EvetEmpty 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>Evet
base_urlstringEvetThe CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
collectionstringEvetThe 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>Evet
auth_headerstringEvetFor the `header` auth scheme — which header the key is sent in.
field_mapobjectEvetRenames, 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…
enabledbooleanEvetA 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_credentialbooleanEvet
capabilitiesstring[]Evet
detected_identitystringEvetWhat the destination said it was, last time it answered.
last_probe_atstringEvet
last_probe_reachablebooleanEvet⛔ `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_codestringEvet
last_probe_detailstringEvet

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422