hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ hosting.backup.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ
Endpoint นี้รับ org_id เป็นฟิลด์ใน JSON body
รหัสองค์กรของคุณจะแสดงอยู่บนหน้าคีย์ API ในแดชบอร์ดของคุณ โดยอยู่ถัดจากคีย์นั้นๆ รหัสนี้จะเป็นรหัสเดิมในการเรียกใช้งานทุกครั้งของคุณ
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
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