Get cluster options
Get all possible options for configuring a cluster.
GET
/
organizations
/
{organizationId}
/
cluster-options
Get cluster options
curl --request GET \
--url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/cluster-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/cluster-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}/cluster-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}/cluster-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}/cluster-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}/cluster-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/cluster-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[
{
"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,
"location": "US"
},
"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,
"location": "US"
}
],
"defaultPodSubnetRange": "172.21.0.0/19",
"defaultServicePeeringRange": "172.23.0.0/20",
"defaultServiceSubnetRange": "172.22.0.0/22"
}
]{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Query Parameters
Response
OK
Was this page helpful?
⌘I
Get cluster options
curl --request GET \
--url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/cluster-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/cluster-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}/cluster-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}/cluster-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}/cluster-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}/cluster-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/cluster-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[
{
"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,
"location": "US"
},
"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,
"location": "US"
}
],
"defaultPodSubnetRange": "172.21.0.0/19",
"defaultServicePeeringRange": "172.23.0.0/20",
"defaultServiceSubnetRange": "172.22.0.0/22"
}
]{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}