hosting

PUT /v1/sites/{siteId}/repo

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

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie hosting.deploy.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).

Treść żądania

NazwaTypWymaganeCo to jest
providerstringTak
ownerstringNie
repostringTak
branchstringNie
build_modeBuildModeNieHow 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_commandstringNie
output_dirstringNie
publish_branchstringNie
auto_deploybooleanNie

Odpowiedź

NazwaTypWymaganeCo to jest
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerstringTakThe git provider — github or gitlab. A machine identifier.
ownerstringTakThe account or namespace the repository lives under.
repostringTak
full_namestringTakowner/repo, or just the repo when the account owns its namespace.
branchstringTakThe branch a push deploys from.
build_modeBuildModeTakHow 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_commandstringTakBlank in publish mode — a stored command nothing runs would read as a build.
output_dirstringTakWhich directory is published. Blank means the repository root.
publish_branchstringTakWhere CI commits the built output in ci mode.
auto_deploybooleanTakWhether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
webhook_urlstringTakThe 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 environment…
webhook_registeredbooleanTakWhether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
last_delivery_atobjectTakWhen 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 token…
last_delivery_notestringTakWhat 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…
connected_accountstringTakThe label of the credential connection this repository is read with.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429