hosting

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

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

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये hosting.backup.manage परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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