hosting

POST `/v1/sites/{siteId}/vendor-snapshots/restore`

Restore a site from a vendor restore point.

المصادقة

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

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

جربه الآن

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

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots/restore \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "scope": <string<web, database, mailbox>>, "timestamp": <string> }'

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

التفاصيل

Rolls the website, one database or one mailbox back to a named restore point. 202 and the whole surface's new state, for the same reason takeSiteVendorSnapshot returns it: the platform performs the restore afterwards and the client polls on in_progress. ⛔ This is the destructive one, and its own path is part of how it is gated. It overwrites the customer's live files and database, so it is deliberately not a verb on the collection that takes backups — it must not be reachable by sending a slightly different body to the endpoint beside it. A restore always names its restore point, never "the latest": timestamp is one of the values getSiteVendorSnapshots returned, and the engine re-checks it against the live listing before anything is sent, so a value a client composed cannot reach the vendor. temp_mailbox applies to mailboxes only, where the platform restores into a temp- prefixed mailbox instead of overwriting the original; it is offered as a choice rather than assumed. The action is audit-logged after the platform accepts it, so the trail never claims a restore a refusal never started. 404 for a site with no vendor hosting package, or one that is not the caller's; 422 for a restore point that is no longer in the listing or a scope that cannot be restored. Requires hosting.backup.manage.

المعلمات

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

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`scope`	`string<web, database, mailbox>`	نعم	What to restore.
`timestamp`	`string`	نعم	The restore point's handle, exactly as `getSiteVendorSnapshots` reported it.
`item_id`	`string`	لا	Which database or mailbox. Empty for the website.
`temp_mailbox`	`boolean`	لا	Mailboxes only. The platform restores into a `temp-` prefixed mailbox instead of overwriting the original, which is the safe default for mail — offered as a choice rather than…

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`available`	`boolean`	نعم	Whether the site's hosting platform has a timeline surface at all. False is our gap, and nothing the customer can do changes it.
`permitted`	`boolean`	نعم	Whether the vendor package type includes it. False is answered by an upgrade.
`pro`	`boolean`	نعم	Whether the package carries the paid tier rather than the included one.
`attached`	`boolean`	نعم	Whether a Timeline Storage service is actually attached to the package. False is the third "no", and it is neither of the other two.
`can_back_up`	`boolean`	نعم	Whether `takeSiteVendorSnapshot` would be accepted right now. Read rather than recomputed from the three flags above, so a screen never offers a button the engine refuses.
`has_dead_web`	`boolean`	نعم	Whether the platform reports the website's timeline as broken. It is surfaced rather than hidden: a customer whose restore points stopped being taken needs to know before they…
`in_progress`	`boolean`	نعم	Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true.
`web`	`SiteVendorSnapshotItem`	نعم	The website's timeline, or null when the platform holds none.
`databases`	`SiteVendorSnapshotItem[]`	نعم	Each database's timeline.
`mailboxes`	`SiteVendorSnapshotItem[]`	نعم	Each mailbox's timeline.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/vendor-snapshots/restore