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 باشد؛ کلیدی که فاقد آن باشد با خطای 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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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