Get cluster options | Astronomer Documentation

curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \
     -H "Authorization: Bearer <token>" \
     -d type=DEDICATED

[
  {
    "databaseInstances": [
      {
        "cpu": 4,
        "memory": "16Gi",
        "name": "e2-standard-4"
      }
    ],
    "defaultDatabaseInstance": {
      "cpu": 4,
      "memory": "16Gi",
      "name": "e2-standard-4"
    },
    "defaultNodeInstance": {
      "cpu": 4,
      "memory": "16Gi",
      "name": "e2-standard-4"
    },
    "defaultRegion": {
      "name": "us-east-1",
      "bannedInstances": [
        "t3.medium"
      ],
      "limited": true
    },
    "defaultVpcSubnetRange": "172.20.0.0/19",
    "nodeCountDefault": 20,
    "nodeCountMax": 100,
    "nodeCountMin": 2,
    "nodeInstances": [
      {
        "cpu": 4,
        "memory": "16Gi",
        "name": "e2-standard-4"
      }
    ],
    "provider": "AZURE",
    "regions": [
      {
        "name": "us-east-1",
        "bannedInstances": [
          "t3.medium"
        ],
        "limited": true
      }
    ],
    "defaultPodSubnetRange": "172.21.0.0/19",
    "defaultServicePeeringRange": "172.23.0.0/20",
    "defaultServiceSubnetRange": "172.22.0.0/22"
  }
]

Get all possible options for configuring a cluster.

curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \
     -H "Authorization: Bearer <token>" \
     -d type=DEDICATED

[
  {
    "databaseInstances": [
      {
        "cpu": 4,
        "memory": "16Gi",
        "name": "e2-standard-4"
      }
    ],
    "defaultDatabaseInstance": {
      "cpu": 4,
      "memory": "16Gi",
      "name": "e2-standard-4"
    },
    "defaultNodeInstance": {
      "cpu": 4,
      "memory": "16Gi",
      "name": "e2-standard-4"
    },
    "defaultRegion": {
      "name": "us-east-1",
      "bannedInstances": [
        "t3.medium"
      ],
      "limited": true
    },
    "defaultVpcSubnetRange": "172.20.0.0/19",
    "nodeCountDefault": 20,
    "nodeCountMax": 100,
    "nodeCountMin": 2,
    "nodeInstances": [
      {
        "cpu": 4,
        "memory": "16Gi",
        "name": "e2-standard-4"
      }
    ],
    "provider": "AZURE",
    "regions": [
      {
        "name": "us-east-1",
        "bannedInstances": [
          "t3.medium"
        ],
        "limited": true
      }
    ],
    "defaultPodSubnetRange": "172.21.0.0/19",
    "defaultServicePeeringRange": "172.23.0.0/20",
    "defaultServiceSubnetRange": "172.22.0.0/22"
  }
]

Get all possible options for configuring a cluster.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization to get cluster options for.

Query parameters

providerenumOptional

The cluster's cloud provider.

Allowed values:

typeenumRequired

The cluster type.

Allowed values:

Response

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

The default pod subnet range.

defaultServicePeeringRangestring

The default service peering range.

defaultServiceSubnetRangestring

The default service subnet range.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \
>	-H "Authorization: Bearer <token>" \
>	-d type=DEDICATED

1	[
2	{
3	"databaseInstances": [
4	{
5	"cpu": 4,
6	"memory": "16Gi",
7	"name": "e2-standard-4"
8	}
9	],
10	"defaultDatabaseInstance": {
11	"cpu": 4,
12	"memory": "16Gi",
13	"name": "e2-standard-4"
14	},
15	"defaultNodeInstance": {
16	"cpu": 4,
17	"memory": "16Gi",
18	"name": "e2-standard-4"
19	},
20	"defaultRegion": {
21	"name": "us-east-1",
22	"bannedInstances": [
23	"t3.medium"
24	],
25	"limited": true
26	},
27	"defaultVpcSubnetRange": "172.20.0.0/19",
28	"nodeCountDefault": 20,
29	"nodeCountMax": 100,
30	"nodeCountMin": 2,
31	"nodeInstances": [
32	{
33	"cpu": 4,
34	"memory": "16Gi",
35	"name": "e2-standard-4"
36	}
37	],
38	"provider": "AZURE",
39	"regions": [
40	{
41	"name": "us-east-1",
42	"bannedInstances": [
43	"t3.medium"
44	],
45	"limited": true
46	}
47	],
48	"defaultPodSubnetRange": "172.21.0.0/19",
49	"defaultServicePeeringRange": "172.23.0.0/20",
50	"defaultServiceSubnetRange": "172.22.0.0/22"
51	}
52	]