hosting

GET /v1/sites/{siteId}/deploy

Get a site's deploy target and status.

Все эндпоинты hosting

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
  -H "Authorization: Bearer zdk_live_…"

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullДаNull when no target can be derived yet.
statusDeployStatusДа`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_atobjectДа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_urlobjectДаThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectДаSource repository for the Pages targets, else null.
commitobjectДаThe deployed commit ref, else null.
messageobjectДаWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanДаFalse while a deploy is in flight or the site cannot be deployed.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429