hosting

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

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

Бүх hosting төгсгөлийн цэгүүд

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх

Дэлгэрэнгүй

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`.

Параметрүүд

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
siteId (path)UuidТиймSite ID (UUIDv7).

Хариу үйлдэл

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
configuredbooleanТийм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…
channelExternalBackupChannel | string<>ТиймEmpty string when `configured` is false.
enabledbooleanТиймA disabled connection is paused, not deleted — the set-up survives.
can_restorebooleanТийм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…
summarystringТийм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_hoststringТиймEmpty on a `connector` connection.
ssh_portintegerТийм
ssh_usernamestringТийм
remote_pathstringТиймThe site's document root — what we archive, and what we restore into.
credential_presentbooleanТиймWhether a credential is stored in our secret store. The credential itself is never returned by any endpoint.
last_verified_atstringТиймNull when the connection has never been checked.
last_verified_okbooleanТиймNull means never checked, which is not the same as failing — the absence of a measurement is not a measurement.
last_verify_detailstringТийм

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 422