hosting
POST /v1/offsite-destinations
Add a place to send backups to, after proving we can write, read and delete there.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 hosting.backup.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点接受 org_id 作为 JSON 正文中的一个字段。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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