hosting

POST `/v1/offsite-destinations`

Add a place to send backups to, after proving we can write, read and delete there.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग hosting.backup.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोटले JSON बडीमा एक फिल्डको रूपमा org_id लिन्छ।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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

POST /v1/offsite-destinations