hosting
GET /v1/sites/{siteId}/deployments/{deploymentId}
One deploy, with its build log.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deployments/{deploymentId} \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The log is written line by line as the build runs rather than at the end, so it is readable while a deploy is in flight and present on one that hangs. Requires `sites.view`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
deploymentId (path) | Uuid | بله | Deployment ID (UUIDv7). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 on… |
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 · 429