hosting

GET /v1/sites/{siteId}/deploy

Get a site's deploy target and status.

Všechny koncové body hosting

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).

Odpověď

NázevTypPožadovánoCo to je
site_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullAnoNull when no target can be derived yet.
statusDeployStatusAno`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_atobjectAnoWhen the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date.
live_urlobjectAnoThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectAnoSource repository for the Pages targets, else null.
commitobjectAnoThe deployed commit ref, else null.
messageobjectAnoWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanAnoFalse while a deploy is in flight or the site cannot be deployed.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429