hosting
GET /v1/sites/{siteId}/deployments/{deploymentId}
One deploy, with its build log.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение 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