hosting

PUT /v1/sites/{siteId}/repo

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

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung hosting.deploy.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).

Anfragekörper

NameTypErforderlichWas es ist
providerstringJa
ownerstringNein
repostringJa
branchstringNein
build_modeBuildModeNeinHow 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_commandstringNein
output_dirstringNein
publish_branchstringNein
auto_deploybooleanNein

Antwort

NameTypErforderlichWas es ist
site_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerstringJaThe git provider — `github` or `gitlab`. A machine identifier.
ownerstringJaThe account or namespace the repository lives under.
repostringJa
full_namestringJa`owner/repo`, or just the repo when the account owns its namespace.
branchstringJaThe branch a push deploys from.
build_modeBuildModeJaHow 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_commandstringJaBlank in `publish` mode — a stored command nothing runs would read as a build.
output_dirstringJaWhich directory is published. Blank means the repository root.
publish_branchstringJaWhere CI commits the built output in `ci` mode.
auto_deploybooleanJaWhether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
webhook_urlstringJaThe 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_registeredbooleanJaWhether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
last_delivery_atobjectJaWhen 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_notestringJaWhat 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_accountstringJaThe label of the credential connection this repository is read with.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429