Get Regions

Get list of regions

Query Parameters

• type RegionType

  Possible values: [DEFAULT, AZURE, AWS, USER_CREATED, OCI, GCP]

  Region type to be filtered

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• regions object[]

  Regions list

  id int32

  name string

  displayName string

  regionType RegionType

  Possible values: [DEFAULT, AZURE, AWS, USER_CREATED, OCI, GCP]

  Type of region

  locations object[]

  Possible values: >= 1

  List of locations in the region

  city string

  state string

  country string

  associatedServers int32

  Number of servers associated to the region

  associatedRegionBasedPlans int32

  Number of plans associated to the region

{
  "regions": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "regionType": "DEFAULT",
      "locations": [
        {
          "city": "string",
          "state": "string",
          "country": "string"
        }
      ],
      "associatedServers": 0,
      "associatedRegionBasedPlans": 0
    }
  ]
}

GET /v4/regions    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

type — query

---DEFAULTAZUREAWSUSER_CREATEDOCIGCP

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/Regions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'