reseller
POST /v1/reseller/brand/panel-hostname
Serve your clients' panel on your own address.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 reseller.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 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) | 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 agen… |
요청 본문
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
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 "pendi… |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 409 · 422 · 429 · 503