List regions

GET

/api/v1/regions

const url = 'https://api.aetherplatform.cloud/api/v1/regions';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aetherplatform.cloud/api/v1/regions

The regions the platform knows about. region on cluster creation must name a region with an enabled Proxmox endpoint configured on this instance (otherwise 422 validation_error); the cluster is recorded under the region this API instance serves. available is informational. Public — no authentication required, so the pre-login signup wizard can populate its picker. Subject to the global rate limit.

available is true only for the region this API instance itself serves (its AETHER_REGION setting); every other entry is informational and is not what cluster creation checks.

Cluster creation accepts only a region this instance can place into: POST /api/v1/organizations/{orgId}/clusters resolves the requested region to an enabled Proxmox endpoint and rejects a region with none with 422 (validation_error, a message naming the region: No Proxmox endpoint is configured for region eu-fi). The created cluster is recorded under the region this instance serves.

The list is static in the binary today — it is not read from the database and does not reflect capacity.

Responses

200

The known regions.

application/json

object

items

required

Never null; the list is static in the binary and is not paginated.

Array<object>

object

required

Region identifier used as region on cluster creation.

string

name

required

string

location

required

string

available

required

True only for the region this API serves.

boolean

Example

{
  "items": [
    {
      "id": "eu-fi",
      "name": "Europe (Finland)",
      "location": "Helsinki",
      "available": true
    }
  ]
}