hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The configured backup channel for a site hosted somewhere else, or an object with configured: false when nobody has set one up yet. A cheap database read; it never touches the customer's server. Never returns a credential. credential_present says whether one is stored in our secret store; the key or password itself cannot be read back through any endpoint once it has been saved. 422 when the site is one we host — its backups are already managed and this surface would be a second, contradictory answer to "is this site backed up?". Gated on sites.view.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
configured | boolean | はい | False when nobody has connected this site yet. The rest of the object is still present and empty — a screen must not have to tell "not set up" from "failed to load" by the absence… |
channel | ExternalBackupChannel | string<> | はい | Empty string when configured is false. |
enabled | boolean | はい | A disabled connection is paused, not deleted — the set-up survives. |
can_restore | boolean | はい | Whether we can push a backup back down this channel. False for connector, and that is not a limitation to route around: a WordPress plugin cannot run inside a WordPress too… |
summary | string | はい | One sentence stating what this connection can and cannot do, composed server-side so every surface says the same thing about the backup/restore asymmetry. |
ssh_host | string | はい | Empty on a connector connection. |
ssh_port | integer | はい | — |
ssh_username | string | はい | — |
remote_path | string | はい | The site's document root — what we archive, and what we restore into. |
credential_present | boolean | はい | Whether a credential is stored in our secret store. The credential itself is never returned by any endpoint. |
last_verified_at | string | はい | Null when the connection has never been checked. |
last_verified_ok | boolean | はい | Null means never checked, which is not the same as failing — the absence of a measurement is not a measurement. |
last_verify_detail | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422