hosting

GET /v1/sites/{siteId}/repo

Get the repository a site deploys from.

すべての hosting エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/repo \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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_idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
providerstringはいThe git provider — `github` or `gitlab`. A machine identifier.
ownerstringはいThe account or namespace the repository lives under.
repostringはい
full_namestringはい`owner/repo`, or just the repo when the account owns its namespace.
branchstringはいThe branch a push deploys from.
build_modeBuildModeはい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_commandstringはいBlank in `publish` mode — a stored command nothing runs would read as a build.
output_dirstringはいWhich directory is published. Blank means the repository root.
publish_branchstringはいWhere CI commits the built output in `ci` mode.
auto_deploybooleanはいWhether a push deploys automatically. Off still records every delivery, so a customer can watch pushes arriving before letting us act on them.
webhook_urlstringはい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_registeredbooleanはいWhether a provider-side hook actually exists. False here with a connection present means pushes are NOT being watched.
last_delivery_atobjectはい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_notestringはい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_accountstringはいThe label of the credential connection this repository is read with.

このエンドポイントが返すエラー

401 · 403 · 404 · 429