hosting
GET /v1/sites/{siteId}/deploy
Get a site's deploy target and status.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
siteId (path) | Uuid | Sì | Site ID (UUIDv7). |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
site_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | Sì | Null when no target can be derived yet. |
status | DeployStatus | Sì | `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 | Sì | 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 | Sì | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | Sì | Source repository for the Pages targets, else null. |
commit | object | Sì | The deployed commit ref, else null. |
message | object | Sì | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | Sì | False while a deploy is in flight or the site cannot be deployed. |
Errori che questo endpoint può restituire
401 · 403 · 404 · 429