compute

GET `/v1/compute/regions`

List the cloud regions a machine can be bought in right now.

Authentication

Send an API key as a bearer token. The key must carry the sites.view 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 GET https://api.zinndigital.com/v1/compute/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

Every region of the Zinn® Cloud range that is both buildable (the live catalogue lists a machine size there) and sold (an orderable size carries a price there). Either alone is a region a customer could choose and then not buy, so neither is enough on its own. A region is a city identified by slug; the client translates it. zone and provider are echoed only so an order form can send the choice back to POST /v1/compute/servers. closest is the available region nearest the visitor's country (a geo hint, null when the country is unknown), for the order screen's "closest to you" default. Requires sites.view.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	The organisation to read for. Required only when the caller belongs to more than one; omitted, it is their own.
`country (query)`	`string`	No	ISO 3166-1 alpha-2 country to answer `closest` for. Omitted, Cloudflare's `CF-IPCountry` is used when present, else the organisation's own stored location (billing profile, order…

Response

Name	Type	Required	What it is
`closest`	`ComputeRegionOption \| null`	No	The available region nearest the customer (`country`, `CF-IPCountry`, else the organisation's stored location), or `null` when that is unknown or nothing is available.
`data`	`ComputeRegion[]`	Yes	—

Errors this endpoint can return

401 · 403 · 422 · 429 · 503