hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
siteId (path) | Uuid | Igen | Site ID (UUIDv7). |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
configured | boolean | Igen | 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<> | Igen | Empty string when `configured` is false. |
enabled | boolean | Igen | A disabled connection is paused, not deleted — the set-up survives. |
can_restore | boolean | Igen | 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 | Igen | 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 | Igen | Empty on a `connector` connection. |
ssh_port | integer | Igen | — |
ssh_username | string | Igen | — |
remote_path | string | Igen | The site's document root — what we archive, and what we restore into. |
credential_present | boolean | Igen | Whether a credential is stored in our secret store. The credential itself is never returned by any endpoint. |
last_verified_at | string | Igen | Null when the connection has never been checked. |
last_verified_ok | boolean | Igen | Null means never checked, which is not the same as failing — the absence of a measurement is not a measurement. |
last_verify_detail | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422