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 рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.
Сіздің ұйым идентификаторыңыз басқару панеліндегі 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.
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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