hosting

POST `/v1/offsite-destinations`

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

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα hosting.backup.manage· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.

Πού μπαίνει το αναγνωριστικό του οργανισμού σας

Αυτό το endpoint δέχεται το πεδίο org_id στο σώμα JSON.

Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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.

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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.

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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