hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
প্রমাণীকরণ
একটি বিয়ারার টোকেন হিসেবে একটি এপিআই কি পাঠান। কি-টির অবশ্যই hosting.backup.manage অনুমতি থাকতে হবে; এটি ছাড়া কোনো কি ৪০৪ নয়, বরং ৪০৩ ত্রুটি দিয়ে প্রত্যাখ্যাত হবে।
যেখানে আপনার অর্গানাইজেশন আইডি দেওয়া হবে
এই এন্ডপয়েন্টটি 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>> }'লগ ইন করা আছে? আপনার ড্যাশবোর্ডের এপিআই কনসোল আপনার আসল অর্গানাইজেশন আইডি এবং আপনার নিজের কি পূরণ করে দেয়, এবং লাইভ এপিআই-এর বিপরীতে অনুরোধটি চালায় যাতে আপনি প্রকৃত প্রতিক্রিয়া দেখতে পান। এই এন্ডপয়েন্টটি এপিআই কনসোলে খুলুন
বিবরণ
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