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, за да можете да видите действителния отговор. Отворете този крайpoint в 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 | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422