hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу hosting.backup.manage; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка узима 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 конзола на вашој контролној табли попуњава ваш прави 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