hosting

POST /v1/sites/{siteId}/deploy

Deploy or redeploy a site.

Todos os endpoints de hosting

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão hosting.deploy.manage; 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 POST 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

Starts a durable deploy workflow and returns immediately with the new in-flight state. The target is derived from the site's stack and its connected accounts; there is no target to choose. A site with a deploy already running returns `DEPLOY_IN_PROGRESS`, and one with no usable target returns `DEPLOY_TARGET_UNAVAILABLE`. Requires `hosting.deploy.manage`.

Parâmetros

NomeTipoObrigatórioO que é
siteId (path)UuidSimSite ID (UUIDv7).
Idempotency-Key (header)stringNãoClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Resposta

NomeTipoObrigatórioO que é
site_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullSimNull when no target can be derived yet.
statusDeployStatusSim`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_atobjectSimWhen the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date.
live_urlobjectSimThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectSimSource repository for the Pages targets, else null.
commitobjectSimThe deployed commit ref, else null.
messageobjectSimWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanSimFalse while a deploy is in flight or the site cannot be deployed.

Erros que este endpoint pode retornar

401 · 403 · 404 · 409 · 422 · 429 · 503