hosting

POST `/v1/offsite-destinations/{destinationId}/test`

Prove the round trip again and record the answer.

المصادقة

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

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

جربه الآن

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

curl -X POST https://api.zinndigital.com/v1/offsite-destinations/{destinationId}/test \
  -H "Authorization: Bearer zdk_live_…"

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

التفاصيل

Writes, reads back and deletes a test file. Always 200; the verdict is in status and last_check_code. Requires hosting.backup.manage.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`destinationId (path)`	`string`	نعم	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`string`	نعم	—
`org_id`	`string`	نعم	—
`name`	`string`	نعم	—
`kind`	`string<s3, sftp>`	نعم	—
`endpoint`	`string`	لا	—
`region`	`string`	لا	—
`bucket`	`string`	لا	—
`host`	`string`	لا	—
`port`	`integer`	لا	—
`username`	`string`	لا	—
`host_key_fingerprint`	`string`	لا	The pinned SFTP host key as `SHA256:…`, the form `ssh-keygen -lf` prints.
`prefix`	`string`	نعم	—
`status`	`string<working, failing>`	نعم	—
`last_checked_at`	`string`	لا	—
`last_check_code`	`string`	لا	—
`sites_using`	`integer`	نعم	—
`created_at`	`string`	نعم	—

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

401 · 403 · 404

POST /v1/offsite-destinations/{destinationId}/test