hosting

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

One deploy, with its build log.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

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

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).
`deploymentId (path)`	`Uuid`	نعم	Deployment ID (UUIDv7).

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`target`	`DeployTarget`	نعم	Where 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…
`status`	`DeployStatus`	نعم	`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.
`trigger`	`DeployTrigger`	نعم	What caused the deploy. Stored because `requested_by` cannot answer it for a push — the actor there is a webhook delivery, not a person.
`repo`	`object`	نعم	—
`branch`	`object`	نعم	—
`commit`	`object`	نعم	—
`commit_message`	`object`	نعم	—
`live_url`	`object`	نعم	—
`message`	`object`	نعم	Why it failed, else null. Rendered to the customer verbatim.
`requested_by`	`string`	نعم	—
`created_at`	`string`	نعم	—
`started_at`	`object`	نعم	—
`finished_at`	`object`	نعم	—
`log`	`string`	نعم	The build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 429

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