catalog
GET /v1/catalog/app/regions
List the hosting regions a new site can be placed in right now.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/catalog/app/regions \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
product_line (query) | string | Не | Only regions with a box that can take a site on this product line. |
include (query) | string<unavailable> | Не | unavailable also lists regions we run that cannot take a site today. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
data | HostingRegion[] | Да | — |
Грешке које ова крајња тачка може вратити
401 · 429