hosting
GET /v1/sites/{siteId}/deploy
Get a site's deploy target and status.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
A site that has never been deployed reports status `idle` with null details — null means "nothing to show", never zero or an epoch. This is polled while a deploy is in flight, so it is a cheap database read and never calls a build provider. Requires `sites.view`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
site_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | Да | Null when no target can be derived yet. |
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. |
last_deployed_at | object | Да | When the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date. |
live_url | object | Да | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | Да | Source repository for the Pages targets, else null. |
commit | object | Да | The deployed commit ref, else null. |
message | object | Да | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | Да | False while a deploy is in flight or the site cannot be deployed. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429