hosting

GET /v1/sites/{siteId}/external-backup

How we reach an externally hosted site to back it up.

Svi hosting krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

NazivVrstaObaveznoŠto je to
siteId (path)UuidDaSite ID (UUIDv7).

Odgovor

NazivVrstaObaveznoŠto je to
configuredbooleanDaFalse 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…
channelExternalBackupChannel | string<>DaEmpty string when configured is false.
enabledbooleanDaA disabled connection is paused, not deleted — the set-up survives.
can_restorebooleanDaWhether 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…
summarystringDaOne 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_hoststringDaEmpty on a connector connection.
ssh_portintegerDa
ssh_usernamestringDa
remote_pathstringDaThe site's document root — what we archive, and what we restore into.
credential_presentbooleanDaWhether a credential is stored in our secret store. The credential itself is never returned by any endpoint.
last_verified_atstringDaNull when the connection has never been checked.
last_verified_okbooleanDaNull means never checked, which is not the same as failing — the absence of a measurement is not a measurement.
last_verify_detailstringDa

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422