hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) hosting.backup.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id | string | Nem | — |
name | string | Igen | — |
kind | string<s3, sftp> | Igen | — |
prefix | string | Nem | — |
endpoint | string | Nem | S3: an https:// endpoint with no path. |
region | string | Nem | S3: the bucket's region, or auto for Cloudflare R2. |
bucket | string | Nem | — |
access_key_id | string | Nem | — |
secret_access_key | string | Nem | — |
host | string | Nem | SFTP: the server's host name. |
port | integer | Nem | — |
username | string | Nem | — |
password | string | Nem | — |
private_key | string | Nem | OpenSSH format. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
org_id | string | Igen | — |
name | string | Igen | — |
kind | string<s3, sftp> | Igen | — |
endpoint | string | Nem | — |
region | string | Nem | — |
bucket | string | Nem | — |
host | string | Nem | — |
port | integer | Nem | — |
username | string | Nem | — |
host_key_fingerprint | string | Nem | The pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints. |
prefix | string | Igen | — |
status | string<working, failing> | Igen | — |
last_checked_at | string | Nem | — |
last_check_code | string | Nem | — |
sites_using | integer | Igen | — |
created_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422