hosting

POST /v1/sites/{siteId}/deploy

Deploy or redeploy a site.

Alle hosting-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie hosting.deploy.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/deploy \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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`.

Parameters

NaamTypeVerplichtWat dit is
siteId (path)UuidJaSite ID (UUIDv7).
Idempotency-Key (header)stringNeeClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Reactie

NaamTypeVerplichtWat dit is
site_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
targetDeployTarget | nullJaNull when no target can be derived yet.
statusDeployStatusJa`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_atobjectJaWhen the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date.
live_urlobjectJaThe served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned.
repoobjectJaSource repository for the Pages targets, else null.
commitobjectJaThe deployed commit ref, else null.
messageobjectJaWhy the last deploy failed, else null. Rendered to the customer verbatim.
can_deploybooleanJaFalse while a deploy is in flight or the site cannot be deployed.

Fouten die dit eindpunt kan retourneren

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