hosting

GET /v1/sites/{siteId}/deploy

Get a site's deploy target and status.

Semua titik akhir hosting

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin sites.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

NamaJenisWajibTentang apa ini
siteId (path)UuidYaSite ID (UUIDv7).

Tanggapan

NamaJenisWajibTentang apa ini
site_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullYaNull when no target can be derived yet.
statusDeployStatusYa`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_atobjectYaWhen the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date.
live_urlobjectYaThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectYaSource repository for the Pages targets, else null.
commitobjectYaThe deployed commit ref, else null.
messageobjectYaWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanYaFalse while a deploy is in flight or the site cannot be deployed.

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429