hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ hosting.deploy.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
A preview NEVER binds the site's hostname: it is reachable at the provider's own per-deployment URL and nowhere else, which is the whole promise of a preview. Previewing the branch the site already serves is refused rather than quietly promoted to a production deploy. Requires hosting.deploy.manage.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
siteId (path) | Uuid | ใช่ | Site ID (UUIDv7). |
เนื้อหาคำขอ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
branch | string | ใช่ | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
id | Uuid | ใช่ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | ใช่ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | ใช่ | Where the site is published from. fleet is our own managed fleet; the rest are managed edge hosts, deployed to from a pooled account of ours or the customer's own connected one.… |
status | DeployStatus | ใช่ | idle means the site has never been deployed. It is reported, never stored — a stored idle would be a second way to say "no deployments" that could contradict the first. |
trigger | DeployTrigger | ใช่ | What caused the deploy. Stored because requested_by cannot answer it for a push — the actor there is a webhook delivery, not a person. |
repo | object | ใช่ | — |
branch | object | ใช่ | — |
commit | object | ใช่ | — |
commit_message | object | ใช่ | — |
live_url | object | ใช่ | — |
message | object | ใช่ | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | ใช่ | — |
created_at | string | ใช่ | — |
started_at | object | ใช่ | — |
finished_at | object | ใช่ | — |
log | string | ใช่ | The build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is. |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 409 · 422 · 429 · 503