hosting

GET /v1/sites/{siteId}/deployments/{deploymentId}

One deploy, with its build log.

Wszystkie punkty końcowe hosting

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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`.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).
deploymentId (path)UuidTakDeployment ID (UUIDv7).

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTargetTakWhere 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…
statusDeployStatusTak`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.
triggerDeployTriggerTakWhat caused the deploy. Stored because `requested_by` cannot answer it for a push — the actor there is a webhook delivery, not a person.
repoobjectTak
branchobjectTak
commitobjectTak
commit_messageobjectTak
live_urlobjectTak
messageobjectTakWhy it failed, else null. Rendered to the customer verbatim.
requested_bystringTak
created_atstringTak
started_atobjectTak
finished_atobjectTak
logstringTakThe build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429