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