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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429