hosting

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

Tell us where this site's posts should go.

Բոլոր hosting վերջնակետերը

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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