hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास hosting.backup.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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.
अनुरोध बॉडी
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
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