hosting

POST `/v1/offsite-destinations`

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

Tabbatar da Asali

Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin hosting.backup.manage; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.

Inda ID ɗin kungiyar ku ke zuwa

Wannan ma'ajiyar tana karɓar org_id a matsayin fili a cikin jikin JSON.

Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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>> }'

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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.

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`org_id`	`string`	A'a	—
`name`	`string`	Eh	—
`kind`	`string<s3, sftp>`	Eh	—
`prefix`	`string`	A'a	—
`endpoint`	`string`	A'a	S3: an https:// endpoint with no path.
`region`	`string`	A'a	S3: the bucket's region, or auto for Cloudflare R2.
`bucket`	`string`	A'a	—
`access_key_id`	`string`	A'a	—
`secret_access_key`	`string`	A'a	—
`host`	`string`	A'a	SFTP: the server's host name.
`port`	`integer`	A'a	—
`username`	`string`	A'a	—
`password`	`string`	A'a	—
`private_key`	`string`	A'a	OpenSSH format.

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`id`	`string`	Eh	—
`org_id`	`string`	Eh	—
`name`	`string`	Eh	—
`kind`	`string<s3, sftp>`	Eh	—
`endpoint`	`string`	A'a	—
`region`	`string`	A'a	—
`bucket`	`string`	A'a	—
`host`	`string`	A'a	—
`port`	`integer`	A'a	—
`username`	`string`	A'a	—
`host_key_fingerprint`	`string`	A'a	The pinned SFTP host key as `SHA256:…`, the form `ssh-keygen -lf` prints.
`prefix`	`string`	Eh	—
`status`	`string<working, failing>`	Eh	—
`last_checked_at`	`string`	A'a	—
`last_check_code`	`string`	A'a	—
`sites_using`	`integer`	Eh	—
`created_at`	`string`	Eh	—

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 404 · 422