hosting

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

Remove our access to an externally hosted site.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن hosting.backup.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/external-backup \
  -H "Authorization: Bearer zdk_live_…"

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Deletes the connection and forgets the stored credential. The backups themselves are **not** deleted. A customer disconnecting us may be doing it precisely so they can restore elsewhere, and their existing restore points are theirs — they expire on the normal retention schedule and are all still downloadable. Requires `hosting.backup.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`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 absen…
`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 to…
`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

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