hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
אימות
שלחו מפתח API כאסימון נושא (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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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