hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
Doğrulama
API açarını bearer token kimi göndərin. Açar hosting.deploy.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
A preview NEVER binds the site's hostname: it is reachable at the provider's own per-deployment URL and nowhere else, which is the whole promise of a preview. Previewing the branch the site already serves is refused rather than quietly promoted to a production deploy. Requires `hosting.deploy.manage`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
siteId (path) | Uuid | Bəli | Site ID (UUIDv7). |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
branch | string | Bəli | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | Bəli | 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 | Bəli | `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 | Bəli | 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 | Bəli | — |
branch | object | Bəli | — |
commit | object | Bəli | — |
commit_message | object | Bəli | — |
live_url | object | Bəli | — |
message | object | Bəli | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | Bəli | — |
created_at | string | Bəli | — |
started_at | object | Bəli | — |
finished_at | object | Bəli | — |
log | string | Bəli | 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. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 409 · 422 · 429 · 503