Skip to content
Management API Reference

[Beta] Gets the list of available regions that can be used for a new project

get/v1/projects/available-regions

OAuth scopes

  • organizations:read

Query parameters

  • organization_slug
    Required
    string

    Slug of your organization

  • continent
    Optional
    enum

    Continent code to determine regional recommendations: NA (North America), SA (South America), EU (Europe), AF (Africa), AS (Asia), OC (Oceania), AN (Antarctica)

  • desired_instance_size
    Optional
    enum

    Desired instance size. Omit this field to always default to the smallest possible size.

Response codes

  • 200

Response (200)

1
{
2
  "recommendations": {
3
    "smartGroup": {
4
      "name": "lorem",
5
      "code": "americas",
6
      "type": "smartGroup"
7
    },
8
    "specific": [
9
      {
10
        "name": "lorem",
11
        "code": "us-east-1",
12
        "type": "specific",
13
        "provider": "AWS",
14
        "status": "capacity"
15
      }
16
    ]
17
  },
18
  "all": {
19
    "smartGroup": [
20
      {
21
        "name": "lorem",
22
        "code": "americas",
23
        "type": "smartGroup"
24
      }
25
    ],
26
    "specific": [
27
      {
28
        "name": "lorem",
29
        "code": "us-east-1",
30
        "type": "specific",
31
        "provider": "AWS",
32
        "status": "capacity"
33
      }
34
    ]
35
  }
36
}