hosting

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

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

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya hosting.backup.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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> }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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`.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`siteId (path)`	`Uuid`	Ndiyo	Site ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`channel`	`ExternalBackupChannel`	Ndiyo	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 ba…
`ssh_host`	`string`	Hapana	Required when `channel` is `ssh`.
`ssh_port`	`integer`	Hapana	—
`ssh_username`	`string`	Hapana	Required when `channel` is `ssh`.
`remote_path`	`string`	Hapana	The document root, required when `channel` is `ssh`. Refused at configuration time rather than at 03:00 when the sweep runs.
`ssh_secret`	`string`	Hapana	The private key (PEM) or password. Written to our secret store and never returned. Omit it to keep the credential already stored.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`configured`	`boolean`	Ndiyo	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<>`	Ndiyo	Empty string when `configured` is false.
`enabled`	`boolean`	Ndiyo	A disabled connection is paused, not deleted — the set-up survives.
`can_restore`	`boolean`	Ndiyo	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`	Ndiyo	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`	Ndiyo	Empty on a `connector` connection.
`ssh_port`	`integer`	Ndiyo	—
`ssh_username`	`string`	Ndiyo	—
`remote_path`	`string`	Ndiyo	The site's document root — what we archive, and what we restore into.
`credential_present`	`boolean`	Ndiyo	Whether a credential is stored in our secret store. The credential itself is never returned by any endpoint.
`last_verified_at`	`string`	Ndiyo	Null when the connection has never been checked.
`last_verified_ok`	`boolean`	Ndiyo	Null means never checked, which is not the same as failing — the absence of a measurement is not a measurement.
`last_verify_detail`	`string`	Ndiyo	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

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