compute
GET /v1/compute/regions/resolve
Answer "can I have a machine in this place?" without placing anything.
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/resolve?location=<location> \
-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
Free text — a city or a country — resolved against the regions available now. ⛔ A place we do not serve is never silently replaced by one we do. status is one of exact (build there — match is set), nearest (we know the place and do not serve it: alternatives are the closest regions, with great-circle distance and an estimated round trip), country (a country was named: alternatives are our regions in it, with no distance, because a country is not a point) or unrecognised (nothing is guessed). requires_confirmation is true for everything but exact, and the customer's own choice goes back through the ordinary order. latency_ms is an estimate from distance, never a measurement. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
location (query) | string | Yes | Where the machine is wanted — a city or a country, in any spelling. |
org_id (query) | Uuid | No | The organisation to resolve for. Required only when the caller belongs to more than one; omitted, it is their own. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | ComputeRegionResolution | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429 · 503