hosting

GET /v1/sites/{siteId}/deploy

Get a site's deploy target and status.

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).

Antwort

NameTypErforderlichWas es ist
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.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429