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 सह नाकारली जाते.

जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल

हा एंडपॉइंट JSON बॉडीमधील फील्ड म्हणून org_id घेतो.

तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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