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