hosting
PUT /v1/sites/{siteId}/external-backup
Connect an externally hosted site so we can back it up.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу hosting.backup.manage; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "channel": <ExternalBackupChannel> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Configures one of two channels. connector — the customer installs the Zinn® Connector plugin and pairs it. Nothing else is needed and we never hold a server credential. The plugin makes outbound calls only; it opens no route on their site. Backup only: it cannot restore. ssh — the customer gives us a host, a username, the document root and a private key. This channel can also push a site back, including when the site itself will not load, which is the only way a one-click restore can be honest. ssh_secret is write-only. It goes straight to our secret store and only a pointer to it is kept; it is never returned by this or any other endpoint. Connecting a connector site mints a fresh plugin token and returns it once as job_token, for the customer to paste into the plugin; re-connecting invalidates whatever the previous install held. Requires hosting.backup.manage.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
channel | ExternalBackupChannel | Да | How we reach a site we do not host. connector is the Zinn® Connector plugin (outbound-only, backup but no restore); ssh is SSH/SFTP, the only channel that can push a site back… |
ssh_host | string | Не | Required when channel is ssh. |
ssh_port | integer | Не | — |
ssh_username | string | Не | Required when channel is ssh. |
remote_path | string | Не | The document root, required when channel is ssh. Refused at configuration time rather than at 03:00 when the sweep runs. |
ssh_secret | string | Не | The private key (PEM) or password. Written to our secret store and never returned. Omit it to keep the credential already stored. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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 | Да | — |
job_token | string | Не | Present only on the response to PUT with channel: connector, and only that once. The token the Zinn® Connector plugin presents when it asks for a backup job — paste it… |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422