توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/repo \
-H "Authorization: Bearer zdk_live_…"لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
A 404 means no repository is connected, which is an ordinary state the dashboard renders as the connect form — deliberately not an empty object, because a payload of blanks cannot be told apart from a failed load. The response carries no secret: the webhook secret is derived from the connection id, never stored. Requires `sites.view`.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
siteId (path) | Uuid | ہاں | Site ID (UUIDv7). |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
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 · 429