hosting
GET /v1/sites/{siteId}/deploy
Get a site's deploy target and status.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso sites.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
siteId (path) | Uuid | Sí | Site ID (UUIDv7). |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429