Platform API ReferenceOptions

Get cluster options

Get all possible options for configuring a cluster.

Path parameters

organizationIdstringRequired
The ID of the Organization to get cluster options for.

Headers

AuthorizationstringRequired

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

Query parameters

providerenumOptional
The cluster's cloud provider.
Allowed values:
typeenumRequired
The cluster type.
Allowed values:

Response

OK
databaseInstanceslist of objects
The available database instances.
defaultDatabaseInstanceobject
defaultNodeInstanceobject
defaultRegionobject
defaultVpcSubnetRangestring
The default VPC subnet range.
nodeCountDefaultinteger
The default number of nodes.
nodeCountMaxinteger
The maximum number of nodes.
nodeCountMininteger
The minimum number of nodes.
nodeInstanceslist of objects
The available node instances.
providerenum
The cloud provider.
Allowed values:
regionslist of objects
The available regions.
defaultPodSubnetRangestring or null
The default pod subnet range.
defaultServicePeeringRangestring or null
The default service peering range.
defaultServiceSubnetRangestring or null
The default service subnet range.

Errors