hosting
PUT /v1/sites/{siteId}/repo
Connect (or re-connect) a repository to a site.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението hosting.deploy.manage; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
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> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
provider | string | Да | — |
owner | string | Не | — |
repo | string | Да | — |
branch | string | Не | — |
build_mode | BuildMode | Не | 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 | Не | — |
output_dir | string | Не | — |
publish_branch | string | Не | — |
auto_deploy | boolean | Не | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
site_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
provider | string | Да | The git provider — `github` or `gitlab`. A machine identifier. |
owner | string | Да | The account or namespace the repository lives under. |
repo | string | Да | — |
full_name | string | Да | `owner/repo`, or just the repo when the account owns its namespace. |
branch | string | Да | The branch a push deploys from. |
build_mode | BuildMode | Да | 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 | Да | Blank in `publish` mode — a stored command nothing runs would read as a build. |
output_dir | string | Да | Which directory is published. Blank means the repository root. |
publish_branch | string | Да | Where CI commits the built output in `ci` mode. |
auto_deploy | boolean | Да | 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 | Да | 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 | Да | Whether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched. |
last_delivery_at | object | Да | 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 | Да | 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 | Да | The label of the credential connection this repository is read with. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429