hosting

PUT /v1/sites/{siteId}/repo

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

Minden hosting végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) hosting.deploy.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Kérés törzse

NévTípusKötelezőMi ez
providerstringIgen
ownerstringNem
repostringIgen
branchstringNem
build_modeBuildModeNemHow 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_commandstringNem
output_dirstringNem
publish_branchstringNem
auto_deploybooleanNem

Válasz

NévTípusKötelezőMi ez
site_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerstringIgenThe git provider — `github` or `gitlab`. A machine identifier.
ownerstringIgenThe account or namespace the repository lives under.
repostringIgen
full_namestringIgen`owner/repo`, or just the repo when the account owns its namespace.
branchstringIgenThe branch a push deploys from.
build_modeBuildModeIgenHow 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_commandstringIgenBlank in `publish` mode — a stored command nothing runs would read as a build.
output_dirstringIgenWhich directory is published. Blank means the repository root.
publish_branchstringIgenWhere CI commits the built output in `ci` mode.
auto_deploybooleanIgenWhether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
webhook_urlstringIgenThe 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_registeredbooleanIgenWhether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
last_delivery_atobjectIgenWhen 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_notestringIgenWhat 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_accountstringIgenThe label of the credential connection this repository is read with.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429