hosting
PUT /v1/sites/{siteId}/cms-target
Tell us where this site's posts should go.
การยืนยันตัวตน
ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
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.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
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, because… |
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