hosting

POST `/v1/offsite-destinations`

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

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس hosting.backup.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ JSON باڈی میں ایک فیلڈ کے طور پر org_id لیتا ہے۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر 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 کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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