hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
siteId (path) | Uuid | Sì | Site ID (UUIDv7). |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
configured | boolean | Sì | 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<> | Sì | Empty string when `configured` is false. |
enabled | boolean | Sì | A disabled connection is paused, not deleted — the set-up survives. |
can_restore | boolean | Sì | 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 | Sì | 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 | Sì | Empty on a `connector` connection. |
ssh_port | integer | Sì | — |
ssh_username | string | Sì | — |
remote_path | string | Sì | The site's document root — what we archive, and what we restore into. |
credential_present | boolean | Sì | Whether a credential is stored in our secret store. The credential itself is never returned by any endpoint. |
last_verified_at | string | Sì | Null when the connection has never been checked. |
last_verified_ok | boolean | Sì | Null means never checked, which is not the same as failing — the absence of a measurement is not a measurement. |
last_verify_detail | string | Sì | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422