reseller

POST `/v1/reseller/brand/panel-hostname`

Serve your clients' panel on your own address.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.manage; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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)`	`Uuid`	Ні	The 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 agency…

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`hostname`	`string`	Так	Just the hostname — `panel.acme.com`, with no scheme and no path. A hostname inside a domain Zinn® operates is refused.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`hostname`	`string`	Так	—
`active`	`boolean`	Так	Measured by fetching it, not read off the edge's status. See `ResellerBrand.panel_hostname_active`.
`provider_status`	`string`	Так	—
`records`	`BrandDnsRecord[]`	Так	—
`errors`	`string[]`	Ні	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…

Помилки, які може повертати ця кінцева точка

401 · 403 · 409 · 422 · 429 · 503

POST /v1/reseller/brand/panel-hostname