hosting

GET /v1/sites/{siteId}/deploy

Get a site's deploy target and status.

Lahat ng hosting endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na sites.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Mga Parameter

PangalanUriKailanganAno ito
siteId (path)UuidOoSite ID (UUIDv7).

Tugon

PangalanUriKailanganAno ito
site_idUuidOoUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullOoNull when no target can be derived yet.
statusDeployStatusOo`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_atobjectOoWhen the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date.
live_urlobjectOoThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectOoSource repository for the Pages targets, else null.
commitobjectOoThe deployed commit ref, else null.
messageobjectOoWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanOoFalse while a deploy is in flight or the site cannot be deployed.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 429