hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
configured | boolean | Ano | 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 absen… |
channel | ExternalBackupChannel | string<> | Ano | Empty string when `configured` is false. |
enabled | boolean | Ano | A disabled connection is paused, not deleted — the set-up survives. |
can_restore | boolean | Ano | 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 to… |
summary | string | Ano | 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 | Ano | Empty on a `connector` connection. |
ssh_port | integer | Ano | — |
ssh_username | string | Ano | — |
remote_path | string | Ano | The site's document root — what we archive, and what we restore into. |
credential_present | boolean | Ano | Whether a credential is stored in our secret store. The credential itself is never returned by any endpoint. |
last_verified_at | string | Ano | Null when the connection has never been checked. |
last_verified_ok | boolean | Ano | Null means never checked, which is not the same as failing — the absence of a measurement is not a measurement. |
last_verify_detail | string | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422