hosting

PUT `/v1/sites/{siteId}/external-backup`

Connect an externally hosted site so we can back it up.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز hosting.backup.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "channel": <ExternalBackupChannel> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Configures one of two channels. connector — the customer installs the Zinn® Connector plugin and pairs it. Nothing else is needed and we never hold a server credential. The plugin makes outbound calls only; it opens no route on their site. Backup only: it cannot restore. ssh — the customer gives us a host, a username, the document root and a private key. This channel can also push a site back, including when the site itself will not load, which is the only way a one-click restore can be honest. ssh_secret is write-only. It goes straight to our secret store and only a pointer to it is kept; it is never returned by this or any other endpoint. Re-connecting a connector site mints a fresh pairing token and invalidates whatever the previous install held. Requires hosting.backup.manage.

پارامترها

نام	نوع	الزامی	چیست
`siteId (path)`	`Uuid`	بله	Site ID (UUIDv7).

بدنه درخواست

نام	نوع	الزامی	چیست
`channel`	`ExternalBackupChannel`	بله	How we reach a site we do not host. `connector` is the Zinn® Connector plugin (outbound-only, backup but no restore); `ssh` is SSH/SFTP, the only channel that can push a site back…
`ssh_host`	`string`	خیر	Required when `channel` is `ssh`.
`ssh_port`	`integer`	خیر	—
`ssh_username`	`string`	خیر	Required when `channel` is `ssh`.
`remote_path`	`string`	خیر	The document root, required when `channel` is `ssh`. Refused at configuration time rather than at 03:00 when the sweep runs.
`ssh_secret`	`string`	خیر	The private key (PEM) or password. Written to our secret store and never returned. Omit it to keep the credential already stored.

پاسخ

نام	نوع	الزامی	چیست
`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 absence…
`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 too…
`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

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