hosting

POST /v1/offsite-destinations

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

Svi hosting krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu hosting.backup.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
org_idstringNe
namestringDa
kindstring<s3, sftp>Da
prefixstringNe
endpointstringNeS3: an https:// endpoint with no path.
regionstringNeS3: the bucket's region, or auto for Cloudflare R2.
bucketstringNe
access_key_idstringNe
secret_access_keystringNe
hoststringNeSFTP: the server's host name.
portintegerNe
usernamestringNe
passwordstringNe
private_keystringNeOpenSSH format.

Odgovor

NazivVrstaObaveznoŠto je to
idstringDa
org_idstringDa
namestringDa
kindstring<s3, sftp>Da
endpointstringNe
regionstringNe
bucketstringNe
hoststringNe
portintegerNe
usernamestringNe
host_key_fingerprintstringNeThe pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints.
prefixstringDa
statusstring<working, failing>Da
last_checked_atstringNe
last_check_codestringNe
sites_usingintegerDa
created_atstringDa

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422