reseller

POST /v1/reseller/brand/panel-hostname

Serve your clients' panel on your own address.

所有 reseller 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/reseller/brand/panel-hostname \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "hostname": <string> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Registers a custom hostname at the edge and returns the DNS to publish. Requires `reseller.manage`. Your clients sign in at your address instead of ours — the address bar is what they look at on every single login, and it is the largest remaining piece of white-label. ⛔ Attaching does **not** make it live and changes no link we emit. Publish the `CNAME`, then call `/verify`. A hostname inside a domain Zinn® operates is refused with `422`, and a hostname is already attached ⇒ `409`.

参数

名称类型必填内容简介
org_id (query)UuidThe organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen…

请求正文

名称类型必填内容简介
hostnamestringJust the hostname — `panel.acme.com`, with no scheme and no path. A hostname inside a domain Zinn® operates is refused.

响应

名称类型必填内容简介
hostnamestring
activebooleanMeasured by fetching it, not read off the edge's status. See `ResellerBrand.panel_hostname_active`.
provider_statusstring
recordsBrandDnsRecord[]
errorsstring[]The edge's own complaints, verbatim, on the verify response — *"custom hostname does not CNAME to this zone"* is a sentence a customer can act on in thirty seconds, where "pendi…

此端点可能返回的错误

401 · 403 · 409 · 422 · 429 · 503