hosting
PUT /v1/sites/{siteId}/cms-target
Tell us where this site's posts should go.
تصدیقهویت
د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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 | هو | — |
د غوښتنې بدن
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
kind | string<wordpress, headless_rest, git_static> | هو | — |
preset | string<, payload, strapi, directus, ghost, shopify, webflow, custom> | نه | — |
base_url | string | نه | — |
collection | string | نه | — |
auth_scheme | string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header> | نه | — |
auth_header | string | نه | — |
field_map | object | نه | — |
enabled | boolean | نه | — |
secret | string | نه | 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_id | string | هو | — |
kind | string<, 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… |
preset | string<, payload, strapi, directus, ghost, shopify, webflow, custom> | هو | — |
base_url | string | هو | The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository). |
collection | string | هو | 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_scheme | string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header> | هو | — |
auth_header | string | هو | For the `header` auth scheme — which header the key is sent in. |
field_map | object | هو | 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… |
enabled | boolean | هو | 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_credential | boolean | هو | — |
capabilities | string[] | هو | — |
detected_identity | string | هو | What the destination said it was, last time it answered. |
last_probe_at | string | هو | — |
last_probe_reachable | boolean | هو | ⛔ `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_code | string | هو | — |
last_probe_detail | string | هو | — |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 404 · 422