hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar hosting.backup.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
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>> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id | string | Hayır | — |
name | string | Evet | — |
kind | string<s3, sftp> | Evet | — |
prefix | string | Hayır | — |
endpoint | string | Hayır | S3: an https:// endpoint with no path. |
region | string | Hayır | S3: the bucket's region, or auto for Cloudflare R2. |
bucket | string | Hayır | — |
access_key_id | string | Hayır | — |
secret_access_key | string | Hayır | — |
host | string | Hayır | SFTP: the server's host name. |
port | integer | Hayır | — |
username | string | Hayır | — |
password | string | Hayır | — |
private_key | string | Hayır | OpenSSH format. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | — |
org_id | string | Evet | — |
name | string | Evet | — |
kind | string<s3, sftp> | Evet | — |
endpoint | string | Hayır | — |
region | string | Hayır | — |
bucket | string | Hayır | — |
host | string | Hayır | — |
port | integer | Hayır | — |
username | string | Hayır | — |
host_key_fingerprint | string | Hayır | The pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints. |
prefix | string | Evet | — |
status | string<working, failing> | Evet | — |
last_checked_at | string | Hayır | — |
last_check_code | string | Hayır | — |
sites_using | integer | Evet | — |
created_at | string | Evet | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 422