hosting

PUT /v1/sites/{siteId}/repo

Connect (or re-connect) a repository to a site.

Todos los endpoints de hosting

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso hosting.deploy.manage; 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 PUT https://api.zinndigital.com/v1/sites/{siteId}/repo \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "provider": <string>, "repo": <string> }'

¿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

Confirms the repository exists on the connected account, stores the connection, and creates or updates the provider-side push webhook — and, when `build_mode` is `ci`, commits the Zinn® build workflow to the repository. The provider work happens before the row is reported as connected, so a hook that could not be created never leaves a row claiming it was. Requires `hosting.deploy.manage`.

Parámetros

NombreTipoObligatorio¿Qué es esto?
siteId (path)UuidSite ID (UUIDv7).

Cuerpo de la solicitud

NombreTipoObligatorio¿Qué es esto?
providerstring
ownerstringNo
repostring
branchstringNo
build_modeBuildModeNoHow the published files are produced. `publish` serves the repository's own files — right for plain HTML and for a repo whose generator output is committed. `ci` runs the build…
build_commandstringNo
output_dirstringNo
publish_branchstringNo
auto_deploybooleanNo

Respuesta

NombreTipoObligatorio¿Qué es esto?
site_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerstringThe git provider — `github` or `gitlab`. A machine identifier.
ownerstringThe account or namespace the repository lives under.
repostring
full_namestring`owner/repo`, or just the repo when the account owns its namespace.
branchstringThe branch a push deploys from.
build_modeBuildModeHow the published files are produced. `publish` serves the repository's own files — right for plain HTML and for a repo whose generator output is committed. `ci` runs the build…
build_commandstringBlank in `publish` mode — a stored command nothing runs would read as a build.
output_dirstringWhich directory is published. Blank means the repository root.
publish_branchstringWhere CI commits the built output in `ci` mode.
auto_deploybooleanWhether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
webhook_urlstringThe URL the provider was told to deliver to. Computed, never stored — a stored copy would keep naming the origin that was current when the row was written. Blank on an environme…
webhook_registeredbooleanWhether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
last_delivery_atobjectWhen the provider last delivered anything, or null for NEVER. Null is the single most useful diagnostic on this screen: "connected but never delivered" is what a mis-scoped toke…
last_delivery_notestringWhat we did with the last delivery, including when we ignored it. Written for every delivery, because "never delivered" and "delivering, ignored" are different problems with dif…
connected_accountstringThe label of the credential connection this repository is read with.

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429