hosting
PUT /v1/sites/{siteId}/cms-target
Tell us where this site's posts should go.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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