Skip to main content
GET
Get cluster options

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to get cluster options for.

Query Parameters

provider
enum<string>

The cluster's cloud provider.

Available options:
AWS,
AZURE,
GCP
type
enum<string>
required

The cluster type.

Available options:
DEDICATED,
HYBRID

Response

OK

databaseInstances
object[]
required

The available database instances.

defaultDatabaseInstance
object
required
defaultNodeInstance
object
required
defaultRegion
object
required
defaultVpcSubnetRange
string
required

The default VPC subnet range.

Example:

"172.20.0.0/19"

nodeCountDefault
integer
required

The default number of nodes.

Example:

20

nodeCountMax
integer
required

The maximum number of nodes.

Example:

100

nodeCountMin
integer
required

The minimum number of nodes.

Example:

2

nodeInstances
object[]
required

The available node instances.

provider
enum<string>
required

The cloud provider.

Available options:
AWS,
AZURE,
GCP
Example:

"AZURE"

regions
object[]
required

The available regions.

defaultPodSubnetRange
string

The default pod subnet range.

Example:

"172.21.0.0/19"

defaultServicePeeringRange
string

The default service peering range.

Example:

"172.23.0.0/20"

defaultServiceSubnetRange
string

The default service subnet range.

Example:

"172.22.0.0/22"