hosting
GET /v1/sites/{siteId}/deploy
Get a site's deploy target and status.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
site_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | Sim | Null when no target can be derived yet. |
status | DeployStatus | Sim | `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 | Sim | 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 | Sim | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | Sim | Source repository for the Pages targets, else null. |
commit | object | Sim | The deployed commit ref, else null. |
message | object | Sim | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | Sim | False while a deploy is in flight or the site cannot be deployed. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429