Skip to content

Regions API ​

Region codes, and which services each region offers.

Wherever the API takes a region, send the lowercase code from GET /v1/regions — for example no (Norway), se (Sweden), dk (Denmark), fi (Finland). The same code appears in hostnames such as {cluster_id}.k8s.no.wayscloud.services.

Two products had their own spelling before these codes. They still accept it, and their responses still use it:

ProductAlso accepted (any letter case)Responses use
Object Storageno-oslo-1no (the only region currently offered)
VPSoslo, norway, no-oslo-1, stockholm, sweden, frankfurt, germany, paris, franceNO

VPS is also offered outside these regions: for VPS, region is the ISO 3166-1 country code of the location (de, nl, …).

The S3 signing region in the S3 examples is no, an S3 client setting; /v1/ip returns a geographic region (state or province), which is not a region code.

GET /v1/regions needs no authentication.

Endpoints ​

MethodPathDescription
GET/v1/regionsList regions
GET/v1/regions/{region_code}Get region

GET /v1/regions ​

List regions

List region codes and the services that can be ordered in each. No authentication.

Response:

FieldTypeDescription
regionsarray
totalinteger

Example:

bash
curl https://api.wayscloud.services/v1/regions \
  -H "X-API-Key: wayscloud_pat_abc12_YOUR_SECRET"

Response:

json
{
  "regions": [
    {
      "code": "no",
      "name": "Norge",
      "city": "Oslo",
      "country": "NO",
      "status": "active",
      "available_services": [
        "storage",
        "databases",
        "redis",
        "apps",
        "llm"
      ]
    },
    {
      "code": "se",
      "name": "Sverige",
      "city": "Stockholm",
      "country": "SE",
      "status": "active",
      "available_services": [
        "databases"
      ]
    }
  ],
  "total": 2
}

GET /v1/regions/ ​

Get region

Get one region and the services that can be ordered in it. No authentication.

Response:

FieldTypeDescription
codestringRegion code — send this wherever the API takes region
namestringDisplay name (currently Norwegian). Do not parse; use code.
citystringDisplay name of the city
countrystringISO 3166-1 alpha-2 country code
statusstringValues: active, maintenance, deprecated
available_servicesarrayServices that can be ordered in this region now. Empty unless status is active. VPS locations are chosen by country code instead, and DNS is not regional.

Example:

bash
curl https://api.wayscloud.services/v1/regions/{region_code} \
  -H "X-API-Key: wayscloud_pat_abc12_YOUR_SECRET"

Response:

json
{
  "code": "no",
  "name": "Norge",
  "city": "Oslo",
  "country": "NO",
  "status": "active",
  "available_services": [
    "storage",
    "databases",
    "redis",
    "apps",
    "llm"
  ]
}