hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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