hosting

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

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

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس hosting.backup.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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