hosting
PUT /v1/sites/{siteId}/repo
Connect (or re-connect) a repository to a site.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429