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 эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Таны байгууллагын дугаар орох газар
Энэ төгсгөлийн цэг нь JSON бие хэсэгт org_id-ийг талбар болгон авдаг.
Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
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 консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй 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