hosting

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

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

Toate punctele finale hosting

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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

NumeTipObligatoriuCe este
siteId (path)UuidDaSite ID (UUIDv7).

Răspuns

NumeTipObligatoriuCe este
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 absen…
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 to…
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

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422