Get Region Details

Get details of the region

Path Parameters

• regionId string required

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• id int32

  Region ID

• name string

  Region name

• displayName string

  Display name for the region

• regionType RegionType

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

  Type of region

• locations object[]

  List of locations in the region

  continent string

  Name of continent for the location

  country string

  Name of country for the location

  state string

  Name of state for the location

  city string

  Name of city for the location

  latitude double

  Latitude for the location

  longitude double

  Longitude for the location

  zone object

  id int32

  name string
• associatedServers object

  Details of servers associated to a region

  serversCount int32

  servers object[]

  server object

  id int32

  name string

  latitude double

  longitude double
• associatedRegionBasedPlans object

  Details of plans associated to the region

  plansCount int32

  plans object[]

  plan object

  id int32

  name string

  associatedServers int32

  type string

  Possible values: [Server, Laptop, FSIBMiVTL, ExchangeJournal, ExchangeUser, Office365, DataClassification, Archiver, CDM, ObjectStore, DLO, Database, Snap, FSServer, VSAServer, Dynamics365]

{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "regionType": "DEFAULT",
  "locations": [
    {
      "continent": "string",
      "country": "string",
      "state": "string",
      "city": "string",
      "latitude": 0,
      "longitude": 0,
      "zone": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "associatedServers": {
    "serversCount": 0,
    "servers": [
      {
        "server": {
          "id": 0,
          "name": "string"
        },
        "latitude": 0,
        "longitude": 0
      }
    ]
  },
  "associatedRegionBasedPlans": {
    "plansCount": 0,
    "plans": [
      {
        "plan": {
          "id": 0,
          "name": "string"
        },
        "associatedServers": 0,
        "type": "Server"
      }
    ]
  }
}

Internal Server Error

GET /v4/regions/:regionid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

regionId — path required

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

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

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

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

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

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

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