The Host Region Object holds available region configurations for a server.

Field

Type

Example

Description

id

Integer

1

The unique ID for the Region.

name

String

"New York"

The name of the Region.

subregion

Object

"subregion":{
  "id":"ams2",
  "description":"2",
  "slug":"ams2",
  "unavailableSizes":[
     "s-3vcpu-1gb",
     "s-1vcpu-2gb",
     "2gb",
  ]
},

The subregion object represents a single subregion to choose from when selecting a region for a server.

subregion.id The ID needed when creating a server.

subregion.description A description of the region.

subregion.slug Human readable strings of the region.

subregion.unavailableSizes A list of size IDs that are unavailable in the region.

subregions

Array of Objects

"subregions":[
  {
     "id":"sfo1",
     "description":"1",
     "slug":"sfo1",
     "unavailableSizes":[

     ]
  },
  {
     "id":"sfo2",
     "description":"2",
     "slug":"sfo2",
     "unavailableSizes":[

     ]
  }
]

A list of subregion objects. Some regions have multiple sub-regions.