hosting
GET /v1/sites/{siteId}/deploy
Get a site's deploy target and status.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
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`.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
siteId (path) | Uuid | כן | Site ID (UUIDv7). |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
site_id | Uuid | כן | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | כן | Null when no target can be derived yet. |
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. |
last_deployed_at | object | כן | When the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date. |
live_url | object | כן | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | כן | Source repository for the Pages targets, else null. |
commit | object | כן | The deployed commit ref, else null. |
message | object | כן | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | כן | False while a deploy is in flight or the site cannot be deployed. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 429