hosting

POST `/v1/offsite-destinations`

Add a place to send backups to, after proving we can write, read and delete there.

المصادقة

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

حيث يتم إدخال معرف مؤسستك

تقبل هذه نقطة النهاية org_id حقلًا في نص JSON.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

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

curl -X POST https://api.zinndigital.com/v1/offsite-destinations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "kind": <string<s3, sftp>> }'

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

التفاصيل

The destination is saved only after a real round trip: a small test file is written, read back byte for byte and deleted. For SFTP the server's host key is read without authenticating and pinned; every later connection must present it. Addresses must be on the public internet and S3 endpoints must be https://. Credentials are write-only and go straight to our secret store with a fresh encryption key; every archive is encrypted (AES-256-CTR with HMAC-SHA256) before it leaves us. Refusals are 422 with a machine code in details[0].code. Requires hosting.backup.manage.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`org_id`	`string`	لا	—
`name`	`string`	نعم	—
`kind`	`string<s3, sftp>`	نعم	—
`prefix`	`string`	لا	—
`endpoint`	`string`	لا	S3: an https:// endpoint with no path.
`region`	`string`	لا	S3: the bucket's region, or auto for Cloudflare R2.
`bucket`	`string`	لا	—
`access_key_id`	`string`	لا	—
`secret_access_key`	`string`	لا	—
`host`	`string`	لا	SFTP: the server's host name.
`port`	`integer`	لا	—
`username`	`string`	لا	—
`password`	`string`	لا	—
`private_key`	`string`	لا	OpenSSH format.

الاستجابة

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