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