Options

Get Deployment options

GET
Get the options available for configuring a Deployment.

Path parameters

organizationIdstringRequired
The ID of the Organization to retrieve Deployment options for.

Query parameters

deploymentIdstringOptional
The ID of a Deployment to retrieve options for.
deploymentTypeenumOptional
The runtime type of the deployment.
Allowed values: HYBRIDDEDICATEDSTANDARD
executorenumOptional
The executor of the deployment.
Allowed values: CELERYKUBERNETES
cloudProviderenumOptional
The cloud provider of the cluster for the deployment.
Allowed values: AWSAZUREGCP

Response

This endpoint returns an object
executors
list of strings
The available executors.
resourceQuotas
object
runtimeReleases
list of objects
The available Astro Runtime versions.
schedulerMachines
list of objects
The available scheduler sizes.
workerMachines
list of objects
The available worker machine types.
workerQueues
object
workloadIdentityOptions
list of objectsOptional
The available workload identity options.
GET
1curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployment-options \
2     -H "Authorization: Bearer <token>"
200Retrieved
1{
2  "executors": [
3    "executors"
4  ],
5  "resourceQuotas": {
6    "defaultPodSize": {
7      "cpu": {
8        "ceiling": "10",
9        "default": "5",
10        "floor": "1"
11      },
12      "memory": {
13        "ceiling": "10",
14        "default": "5",
15        "floor": "1"
16      }
17    },
18    "resourceQuota": {
19      "cpu": {
20        "ceiling": "10",
21        "default": "5",
22        "floor": "1"
23      },
24      "memory": {
25        "ceiling": "10",
26        "default": "5",
27        "floor": "1"
28      }
29    }
30  },
31  "runtimeReleases": [
32    {
33      "airflowDatabaseMigration": false,
34      "airflowVersion": "2.7.1",
35      "channel": "stable",
36      "releaseDate": "2022-11-22T04:37:12Z",
37      "stellarDatabaseMigration": false,
38      "version": "9.1.0"
39    }
40  ],
41  "schedulerMachines": [
42    {
43      "name": "SMALL",
44      "spec": {
45        "cpu": "1",
46        "memory": "2Gi",
47        "concurrency": 10,
48        "ephemeralStorage": "10Gi"
49      }
50    }
51  ],
52  "workerMachines": [
53    {
54      "concurrency": {
55        "ceiling": 10,
56        "default": 5,
57        "floor": 1
58      },
59      "name": "A5",
60      "spec": {
61        "cpu": "1",
62        "memory": "2Gi",
63        "concurrency": 10,
64        "ephemeralStorage": "10Gi"
65      }
66    }
67  ],
68  "workerQueues": {
69    "maxWorkers": {
70      "ceiling": 10,
71      "default": 5,
72      "floor": 1
73    },
74    "minWorkers": {
75      "ceiling": 10,
76      "default": 5,
77      "floor": 1
78    },
79    "workerConcurrency": {
80      "ceiling": 10,
81      "default": 5,
82      "floor": 1
83    }
84  },
85  "workloadIdentityOptions": [
86    {
87      "label": "workload-label",
88      "role": "workload-role"
89    }
90  ]
91}
Built with