hosting

PUT /v1/sites/{siteId}/offsite

Send this site's backups to a destination.

جميع نقاط نهاية hosting

جميع مستندات المطورين

المصادقة

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

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

جربه الآن

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

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/offsite \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "destination_id": <string>, "retention_days": <integer<7, 30, 90, 180, 365>> }'

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

التفاصيل

Requires the add-on for this site and an account in good standing. Switching on copies the newest restorable backup (and any archives it depends on) at once, then every later backup. Changing destination drops copies still waiting for the old one; stored copies stay. Requires hosting.backup.manage.

المعلمات

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

جسم الطلب

الاسمالنوعمطلوبما هو هذا
destination_idstringنعم
retention_daysinteger<7, 30, 90, 180, 365>نعم
enabledbooleanلا

الاستجابة

الاسمالنوعمطلوبما هو هذا
site_idstringنعم
entitledbooleanنعم
extra_codestringنعم
retention_choicesinteger[]نعم
policyobjectنعم
copiesOffsiteCopy[]نعم

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

401 · 403 · 404 · 422