Skip to main content
GET
/
v1
/
regions
/
global
/
locations
List regions
const options = {method: 'GET'};

fetch('https://api.example.com/v1/regions/global/locations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "location": {
        "country": "<string>",
        "city": "<string>",
        "continent": "<string>",
        "coordinates": {
          "latitude": 123,
          "longitude": 123
        }
      },
      "status": "active",
      "services": [
        "<string>"
      ],
      "capabilities": {
        "compute": true,
        "storage": true,
        "networking": true,
        "kubernetes": true
      },
      "endpoints": {
        "api": "<string>",
        "console": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123
  }
}

Query Parameters

status
enum<string>

Filter by region status

Available options:
active,
maintenance,
deprecated
service
string

Filter by available service

Response

200 - application/json

List of regions

success
enum<boolean>
Available options:
true
data
object[]
meta
object