hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 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