hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს hosting.backup.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
სwhere your organisation id goes-ის ადგილი
ესენდპოინტი იღებს org_id-ს JSON ტანის ველად.
თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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