reseller

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

Serve your clients' panel on your own address.

Authentication

Send an API key as a bearer token. The key must carry the reseller.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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`.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	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…

Request body

Name	Type	Required	What it is
`hostname`	`string`	Yes	Just the hostname — `panel.acme.com`, with no scheme and no path. A hostname inside a domain Zinn® operates is refused.

Response

Name	Type	Required	What it is
`hostname`	`string`	Yes	—
`active`	`boolean`	Yes	Measured by fetching it, not read off the edge's status. See `ResellerBrand.panel_hostname_active`.
`provider_status`	`string`	Yes	—
`records`	`BrandDnsRecord[]`	Yes	—
`errors`	`string[]`	No	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…

Errors this endpoint can return

401 · 403 · 409 · 422 · 429 · 503