hosting

PUT /v1/sites/{siteId}/repo

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

Všechny koncové body hosting

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění hosting.deploy.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
providerstringAno
ownerstringNe
repostringAno
branchstringNe
build_modeBuildModeNeHow 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_commandstringNe
output_dirstringNe
publish_branchstringNe
auto_deploybooleanNe

Odpověď

NázevTypPožadovánoCo to je
site_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerstringAnoThe git provider — github or gitlab. A machine identifier.
ownerstringAnoThe account or namespace the repository lives under.
repostringAno
full_namestringAnoowner/repo, or just the repo when the account owns its namespace.
branchstringAnoThe branch a push deploys from.
build_modeBuildModeAnoHow 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_commandstringAnoBlank in publish mode — a stored command nothing runs would read as a build.
output_dirstringAnoWhich directory is published. Blank means the repository root.
publish_branchstringAnoWhere CI commits the built output in ci mode.
auto_deploybooleanAnoWhether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
webhook_urlstringAnoThe 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_registeredbooleanAnoWhether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
last_delivery_atobjectAnoWhen 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_notestringAnoWhat 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_accountstringAnoThe label of the credential connection this repository is read with.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429