hosting
GET /v1/sites/{siteId}/external-backup
How we reach an externally hosted site to back it up.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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). |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
configured | boolean | כן | 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<> | כן | Empty string when `configured` is false. |
enabled | boolean | כן | A disabled connection is paused, not deleted — the set-up survives. |
can_restore | boolean | כן | 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 | כן | 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 | כן | Empty on a `connector` connection. |
ssh_port | integer | כן | — |
ssh_username | string | כן | — |
remote_path | string | כן | The site's document root — what we archive, and what we restore into. |
credential_present | boolean | כן | Whether a credential is stored in our secret store. The credential itself is never returned by any endpoint. |
last_verified_at | string | כן | Null when the connection has never been checked. |
last_verified_ok | boolean | כן | Null means never checked, which is not the same as failing — the absence of a measurement is not a measurement. |
last_verify_detail | string | כן | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422