Get Deployment options
curl --request GET \
--url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"executors": [
"<string>"
],
"resourceQuotas": {
"defaultPodSize": {
"cpu": {
"ceiling": "10",
"default": "5",
"floor": "1"
},
"memory": {
"ceiling": "10",
"default": "5",
"floor": "1"
}
},
"resourceQuota": {
"cpu": {
"ceiling": "10",
"default": "5",
"floor": "1"
},
"memory": {
"ceiling": "10",
"default": "5",
"floor": "1"
}
}
},
"runtimeReleases": [
{
"airflowDatabaseMigration": false,
"airflowVersion": "2.7.1",
"channel": "stable",
"releaseDate": "2022-11-22T04:37:12Z",
"stellarDatabaseMigration": false,
"version": "9.1.0"
}
],
"schedulerMachines": [
{
"spec": {
"cpu": "1",
"memory": "2Gi",
"concurrency": 10,
"ephemeralStorage": "10Gi"
}
}
],
"workerMachines": [
{
"concurrency": {
"ceiling": 10,
"default": 5,
"floor": 1
},
"spec": {
"cpu": "1",
"memory": "2Gi",
"concurrency": 10,
"ephemeralStorage": "10Gi"
}
}
],
"workerQueues": {
"maxWorkers": {
"ceiling": 10,
"default": 5,
"floor": 1
},
"minWorkers": {
"ceiling": 10,
"default": 5,
"floor": 1
},
"workerConcurrency": {
"ceiling": 10,
"default": 5,
"floor": 1
}
},
"workloadIdentityOptions": [
{
"label": "workload-label",
"role": "workload-role"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}Options
Get Deployment options
Get the options available for configuring a Deployment.
GET
/
organizations
/
{organizationId}
/
deployment-options
Get Deployment options
curl --request GET \
--url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployment-options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"executors": [
"<string>"
],
"resourceQuotas": {
"defaultPodSize": {
"cpu": {
"ceiling": "10",
"default": "5",
"floor": "1"
},
"memory": {
"ceiling": "10",
"default": "5",
"floor": "1"
}
},
"resourceQuota": {
"cpu": {
"ceiling": "10",
"default": "5",
"floor": "1"
},
"memory": {
"ceiling": "10",
"default": "5",
"floor": "1"
}
}
},
"runtimeReleases": [
{
"airflowDatabaseMigration": false,
"airflowVersion": "2.7.1",
"channel": "stable",
"releaseDate": "2022-11-22T04:37:12Z",
"stellarDatabaseMigration": false,
"version": "9.1.0"
}
],
"schedulerMachines": [
{
"spec": {
"cpu": "1",
"memory": "2Gi",
"concurrency": 10,
"ephemeralStorage": "10Gi"
}
}
],
"workerMachines": [
{
"concurrency": {
"ceiling": 10,
"default": 5,
"floor": 1
},
"spec": {
"cpu": "1",
"memory": "2Gi",
"concurrency": 10,
"ephemeralStorage": "10Gi"
}
}
],
"workerQueues": {
"maxWorkers": {
"ceiling": 10,
"default": 5,
"floor": 1
},
"minWorkers": {
"ceiling": 10,
"default": 5,
"floor": 1
},
"workerConcurrency": {
"ceiling": 10,
"default": 5,
"floor": 1
}
},
"workloadIdentityOptions": [
{
"label": "workload-label",
"role": "workload-role"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Organization to retrieve Deployment options for.
Query Parameters
The ID of a Deployment to retrieve options for.
The runtime type of the deployment.
Available options:
HYBRID, DEDICATED, STANDARD The executor of the deployment.
Available options:
CELERY, KUBERNETES, ASTRO The cloud provider of the cluster for the deployment.
Available options:
AWS, AZURE, GCP Response
OK
The available executors.
Show child attributes
Show child attributes
The available Astro Runtime versions.
Show child attributes
Show child attributes
The available scheduler sizes.
Show child attributes
Show child attributes
The available worker machine types.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The available workload identity options.
Show child attributes
Show child attributes
Was this page helpful?
⌘I