hosting

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

Tell us where this site's posts should go.

Барлық hosting соңғы нүктелері

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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.

Параметрлер

АтыTүріМіндеттіМазмұны
siteId (path)stringИә

Сұрау денесі

АтыTүріМіндеттіМазмұны
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…

Жауап

АтыTүріМіндеттіМазмұны
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