hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
Doğrulama
API açarını bearer token kimi göndərin. Açar hosting.backup.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə JSON gövdəsində sahə kimi org_id qəbul edir.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
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>> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
org_id | string | Xeyr | — |
name | string | Bəli | — |
kind | string<s3, sftp> | Bəli | — |
prefix | string | Xeyr | — |
endpoint | string | Xeyr | S3: an https:// endpoint with no path. |
region | string | Xeyr | S3: the bucket's region, or auto for Cloudflare R2. |
bucket | string | Xeyr | — |
access_key_id | string | Xeyr | — |
secret_access_key | string | Xeyr | — |
host | string | Xeyr | SFTP: the server's host name. |
port | integer | Xeyr | — |
username | string | Xeyr | — |
password | string | Xeyr | — |
private_key | string | Xeyr | OpenSSH format. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | string | Bəli | — |
org_id | string | Bəli | — |
name | string | Bəli | — |
kind | string<s3, sftp> | Bəli | — |
endpoint | string | Xeyr | — |
region | string | Xeyr | — |
bucket | string | Xeyr | — |
host | string | Xeyr | — |
port | integer | Xeyr | — |
username | string | Xeyr | — |
host_key_fingerprint | string | Xeyr | The pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints. |
prefix | string | Bəli | — |
status | string<working, failing> | Bəli | — |
last_checked_at | string | Xeyr | — |
last_check_code | string | Xeyr | — |
sites_using | integer | Bəli | — |
created_at | string | Bəli | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422