hosting

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

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

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग 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