hosting

PUT `/v1/sites/{siteId}/repo`

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

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 PUT https://api.zinndigital.com/v1/sites/{siteId}/repo \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "provider": <string>, "repo": <string> }'

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

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

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`Uuid`	Sim	Site ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`provider`	`string`	Sim	—
`owner`	`string`	Não	—
`repo`	`string`	Sim	—
`branch`	`string`	Não	—
`build_mode`	`BuildMode`	Não	How 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_command`	`string`	Não	—
`output_dir`	`string`	Não	—
`publish_branch`	`string`	Não	—
`auto_deploy`	`boolean`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`site_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`provider`	`string`	Sim	The git provider — `github` or `gitlab`. A machine identifier.
`owner`	`string`	Sim	The account or namespace the repository lives under.
`repo`	`string`	Sim	—
`full_name`	`string`	Sim	`owner/repo`, or just the repo when the account owns its namespace.
`branch`	`string`	Sim	The branch a push deploys from.
`build_mode`	`BuildMode`	Sim	How 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_command`	`string`	Sim	Blank in `publish` mode — a stored command nothing runs would read as a build.
`output_dir`	`string`	Sim	Which directory is published. Blank means the repository root.
`publish_branch`	`string`	Sim	Where CI commits the built output in `ci` mode.
`auto_deploy`	`boolean`	Sim	Whether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
`webhook_url`	`string`	Sim	The 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_registered`	`boolean`	Sim	Whether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
`last_delivery_at`	`object`	Sim	When 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_note`	`string`	Sim	What 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_account`	`string`	Sim	The label of the credential connection this repository is read with.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429

PUT /v1/sites/{siteId}/repo