GET /v1/catalog/app/regions

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

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/catalog/app/regions \
  -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

The regions of our own fleet that have a box able to take a new site right now — derived from the servers registered in each region, never from a typed list. A region with no capacity is simply absent: there is no "coming soon" entry to render. When a server is registered in a new region it appears here on the next read, with no client change. code is the value createSite, the checkout (addCartLine) and createPartnerHostingOrder accept as region. Sending a region that is not in this list is refused before anything is created: a region we run that has no capacity today is a 422 with error code REGION_UNAVAILABLE (region_unavailable on the partner order), naming the regions that are available. Render name_key from your catalogue where you have one (our own consoles carry it in every language); city is the English fallback and country is ISO-3166 alpha-2 for a decorative flag — never the accessible name. With exactly one region a client may state it as a fact rather than render a one-option picker. Signed-in, non-tenant data (a partner API key reaches it exactly as it reaches listInAppCatalogPlans). product_line narrows the answer to boxes that serve that line in the pool its sites are placed in. include=unavailable adds every region we run with available: false — for staff tooling only; a picker must never pass it.

Parameters

Response

Errors this endpoint can return

401 · 429