hosting
GET /v1/sites/servers
The servers the caller's sites run on, with how many sites each.
Authentication
Send an API key as a bearer token. The endpoint checks sites.view; 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 GET https://api.zinndigital.com/v1/sites/servers \
-H "Authorization: Bearer zdk_live_…"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
⚖️ Owner decision D43 (s1006): the site list shows "sites on servers with clear labels", and a customer with thousands of sites needs the inverse question — which of my sites are on this server? This is the option list for listSites's server filter. It applies the same scope and filters as listSites (org_id, status, product_line, group, search), so each sites count is exactly the number of rows listSites?server=<key> returns. One grouped read over the placement columns: a handful of entries however many sites the organization has. A server on our own fleet is named by region and number (fleet:hel1-1, rendered "Helsinki server 1"); its hostname and id are platform infrastructure and are never returned. A customer's own server and connected panel carry the name the customer gave them.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
X-Zinn-Org (header) | string | No | Which organisation this call acts for. Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
org_id (query) | Uuid | No | Restrict to one organization in the caller's scope. |
status (query) | SiteStatus | No | — |
product_line (query) | string | No | — |
group (query) | string | No | — |
search (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | SiteServerFacet[] | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429