Update a cluster

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "k8sTags": [
    {
      "key": "key1",
      "value": "value1"
    }
  ],
  "name": "My cluster",
  "clusterType": "DEDICATED",
  "dbInstanceType": "Small General Purpose",
  "enableDr": true,
  "isFailedOver": true,
  "nodePools": [
    {
      "maxNodeCount": 10,
      "name": "my-nodepool",
      "nodeInstanceType": "t3.medium",
      "id": "clm8bvk8b000008l9deowc5lx",
      "isDefault": true
    }
  ],
  "workspaceIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}"

payload = {
    "k8sTags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ],
    "name": "My cluster",
    "clusterType": "DEDICATED",
    "dbInstanceType": "Small General Purpose",
    "enableDr": True,
    "isFailedOver": True,
    "nodePools": [
        {
            "maxNodeCount": 10,
            "name": "my-nodepool",
            "nodeInstanceType": "t3.medium",
            "id": "clm8bvk8b000008l9deowc5lx",
            "isDefault": True
        }
    ],
    "workspaceIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    k8sTags: [{key: 'key1', value: 'value1'}],
    name: 'My cluster',
    clusterType: 'DEDICATED',
    dbInstanceType: 'Small General Purpose',
    enableDr: true,
    isFailedOver: true,
    nodePools: [
      {
        maxNodeCount: 10,
        name: 'my-nodepool',
        nodeInstanceType: 't3.medium',
        id: 'clm8bvk8b000008l9deowc5lx',
        isDefault: true
      }
    ],
    workspaceIds: ['<string>']
  })
};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}', 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}/clusters/{clusterId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'k8sTags' => [
        [
                'key' => 'key1',
                'value' => 'value1'
        ]
    ],
    'name' => 'My cluster',
    'clusterType' => 'DEDICATED',
    'dbInstanceType' => 'Small General Purpose',
    'enableDr' => true,
    'isFailedOver' => true,
    'nodePools' => [
        [
                'maxNodeCount' => 10,
                'name' => 'my-nodepool',
                'nodeInstanceType' => 't3.medium',
                'id' => 'clm8bvk8b000008l9deowc5lx',
                'isDefault' => true
        ]
    ],
    'workspaceIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}"

	payload := strings.NewReader("{\n  \"k8sTags\": [\n    {\n      \"key\": \"key1\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"name\": \"My cluster\",\n  \"clusterType\": \"DEDICATED\",\n  \"dbInstanceType\": \"Small General Purpose\",\n  \"enableDr\": true,\n  \"isFailedOver\": true,\n  \"nodePools\": [\n    {\n      \"maxNodeCount\": 10,\n      \"name\": \"my-nodepool\",\n      \"nodeInstanceType\": \"t3.medium\",\n      \"id\": \"clm8bvk8b000008l9deowc5lx\",\n      \"isDefault\": true\n    }\n  ],\n  \"workspaceIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"k8sTags\": [\n    {\n      \"key\": \"key1\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"name\": \"My cluster\",\n  \"clusterType\": \"DEDICATED\",\n  \"dbInstanceType\": \"Small General Purpose\",\n  \"enableDr\": true,\n  \"isFailedOver\": true,\n  \"nodePools\": [\n    {\n      \"maxNodeCount\": 10,\n      \"name\": \"my-nodepool\",\n      \"nodeInstanceType\": \"t3.medium\",\n      \"id\": \"clm8bvk8b000008l9deowc5lx\",\n      \"isDefault\": true\n    }\n  ],\n  \"workspaceIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"k8sTags\": [\n    {\n      \"key\": \"key1\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"name\": \"My cluster\",\n  \"clusterType\": \"DEDICATED\",\n  \"dbInstanceType\": \"Small General Purpose\",\n  \"enableDr\": true,\n  \"isFailedOver\": true,\n  \"nodePools\": [\n    {\n      \"maxNodeCount\": 10,\n      \"name\": \"my-nodepool\",\n      \"nodeInstanceType\": \"t3.medium\",\n      \"id\": \"clm8bvk8b000008l9deowc5lx\",\n      \"isDefault\": true\n    }\n  ],\n  \"workspaceIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "cloudProvider": "AWS",
  "createdAt": "2022-11-22T04:37:12Z",
  "dbInstanceType": "db.t3.medium",
  "drRegion": "us-east-1",
  "id": "clm7k8tgw000008jz97i37y81",
  "isDrEnabled": true,
  "name": "my cluster",
  "organizationId": "clm88r8hi000008jwhzxu5crg",
  "region": "us-east-1",
  "status": "CREATED",
  "type": "DEDICATED",
  "updatedAt": "2022-11-22T04:37:12Z",
  "vpcSubnetRange": "172.20.0.0/22",
  "drSecondaryVpcCidr": "<string>",
  "drVpcSubnetRange": "<string>",
  "enableReplicationTimeControl": true,
  "failoverInProgress": true,
  "healthStatus": {
    "value": "HEALTHY",
    "details": [
      {
        "code": "<string>",
        "description": "<string>",
        "severity": "<string>",
        "component": "<string>"
      }
    ]
  },
  "isFailedOver": true,
  "isLimited": false,
  "metadata": {
    "externalIPs": [
      "35.100.100.1"
    ],
    "kubeDnsIp": "10.100.100.0",
    "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/"
  },
  "nodePools": [
    {
      "cloudProvider": "AWS",
      "clusterId": "clm891jb6000308jrc3vjdtde",
      "createdAt": "2022-11-22T04:37:12Z",
      "id": "clm890zhe000208jr39dd0ubs",
      "isDefault": true,
      "maxNodeCount": 1,
      "name": "default",
      "nodeInstanceType": "t3.medium",
      "updatedAt": "2022-11-22T04:37:12Z",
      "supportedAstroMachines": [
        "A5",
        "A10"
      ]
    }
  ],
  "podSubnetRange": "172.21.0.0/19",
  "providerAccount": "provider-account",
  "secondaryVpcCidr": "<string>",
  "servicePeeringRange": "172.23.0.0/20",
  "serviceSubnetRange": "172.22.0.0/22",
  "tags": [
    {
      "key": "key1",
      "value": "value1"
    }
  ],
  "tenantId": "your-tenant-id",
  "workspaceIds": [
    "clm88rddl000108jwgeka2div"
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

POST

organizations

{organizationId}

clusters

{clusterId}

Update a cluster

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "k8sTags": [
    {
      "key": "key1",
      "value": "value1"
    }
  ],
  "name": "My cluster",
  "clusterType": "DEDICATED",
  "dbInstanceType": "Small General Purpose",
  "enableDr": true,
  "isFailedOver": true,
  "nodePools": [
    {
      "maxNodeCount": 10,
      "name": "my-nodepool",
      "nodeInstanceType": "t3.medium",
      "id": "clm8bvk8b000008l9deowc5lx",
      "isDefault": true
    }
  ],
  "workspaceIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}"

payload = {
    "k8sTags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ],
    "name": "My cluster",
    "clusterType": "DEDICATED",
    "dbInstanceType": "Small General Purpose",
    "enableDr": True,
    "isFailedOver": True,
    "nodePools": [
        {
            "maxNodeCount": 10,
            "name": "my-nodepool",
            "nodeInstanceType": "t3.medium",
            "id": "clm8bvk8b000008l9deowc5lx",
            "isDefault": True
        }
    ],
    "workspaceIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    k8sTags: [{key: 'key1', value: 'value1'}],
    name: 'My cluster',
    clusterType: 'DEDICATED',
    dbInstanceType: 'Small General Purpose',
    enableDr: true,
    isFailedOver: true,
    nodePools: [
      {
        maxNodeCount: 10,
        name: 'my-nodepool',
        nodeInstanceType: 't3.medium',
        id: 'clm8bvk8b000008l9deowc5lx',
        isDefault: true
      }
    ],
    workspaceIds: ['<string>']
  })
};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}', 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}/clusters/{clusterId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'k8sTags' => [
        [
                'key' => 'key1',
                'value' => 'value1'
        ]
    ],
    'name' => 'My cluster',
    'clusterType' => 'DEDICATED',
    'dbInstanceType' => 'Small General Purpose',
    'enableDr' => true,
    'isFailedOver' => true,
    'nodePools' => [
        [
                'maxNodeCount' => 10,
                'name' => 'my-nodepool',
                'nodeInstanceType' => 't3.medium',
                'id' => 'clm8bvk8b000008l9deowc5lx',
                'isDefault' => true
        ]
    ],
    'workspaceIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}"

	payload := strings.NewReader("{\n  \"k8sTags\": [\n    {\n      \"key\": \"key1\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"name\": \"My cluster\",\n  \"clusterType\": \"DEDICATED\",\n  \"dbInstanceType\": \"Small General Purpose\",\n  \"enableDr\": true,\n  \"isFailedOver\": true,\n  \"nodePools\": [\n    {\n      \"maxNodeCount\": 10,\n      \"name\": \"my-nodepool\",\n      \"nodeInstanceType\": \"t3.medium\",\n      \"id\": \"clm8bvk8b000008l9deowc5lx\",\n      \"isDefault\": true\n    }\n  ],\n  \"workspaceIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"k8sTags\": [\n    {\n      \"key\": \"key1\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"name\": \"My cluster\",\n  \"clusterType\": \"DEDICATED\",\n  \"dbInstanceType\": \"Small General Purpose\",\n  \"enableDr\": true,\n  \"isFailedOver\": true,\n  \"nodePools\": [\n    {\n      \"maxNodeCount\": 10,\n      \"name\": \"my-nodepool\",\n      \"nodeInstanceType\": \"t3.medium\",\n      \"id\": \"clm8bvk8b000008l9deowc5lx\",\n      \"isDefault\": true\n    }\n  ],\n  \"workspaceIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/clusters/{clusterId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"k8sTags\": [\n    {\n      \"key\": \"key1\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"name\": \"My cluster\",\n  \"clusterType\": \"DEDICATED\",\n  \"dbInstanceType\": \"Small General Purpose\",\n  \"enableDr\": true,\n  \"isFailedOver\": true,\n  \"nodePools\": [\n    {\n      \"maxNodeCount\": 10,\n      \"name\": \"my-nodepool\",\n      \"nodeInstanceType\": \"t3.medium\",\n      \"id\": \"clm8bvk8b000008l9deowc5lx\",\n      \"isDefault\": true\n    }\n  ],\n  \"workspaceIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "cloudProvider": "AWS",
  "createdAt": "2022-11-22T04:37:12Z",
  "dbInstanceType": "db.t3.medium",
  "drRegion": "us-east-1",
  "id": "clm7k8tgw000008jz97i37y81",
  "isDrEnabled": true,
  "name": "my cluster",
  "organizationId": "clm88r8hi000008jwhzxu5crg",
  "region": "us-east-1",
  "status": "CREATED",
  "type": "DEDICATED",
  "updatedAt": "2022-11-22T04:37:12Z",
  "vpcSubnetRange": "172.20.0.0/22",
  "drSecondaryVpcCidr": "<string>",
  "drVpcSubnetRange": "<string>",
  "enableReplicationTimeControl": true,
  "failoverInProgress": true,
  "healthStatus": {
    "value": "HEALTHY",
    "details": [
      {
        "code": "<string>",
        "description": "<string>",
        "severity": "<string>",
        "component": "<string>"
      }
    ]
  },
  "isFailedOver": true,
  "isLimited": false,
  "metadata": {
    "externalIPs": [
      "35.100.100.1"
    ],
    "kubeDnsIp": "10.100.100.0",
    "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/"
  },
  "nodePools": [
    {
      "cloudProvider": "AWS",
      "clusterId": "clm891jb6000308jrc3vjdtde",
      "createdAt": "2022-11-22T04:37:12Z",
      "id": "clm890zhe000208jr39dd0ubs",
      "isDefault": true,
      "maxNodeCount": 1,
      "name": "default",
      "nodeInstanceType": "t3.medium",
      "updatedAt": "2022-11-22T04:37:12Z",
      "supportedAstroMachines": [
        "A5",
        "A10"
      ]
    }
  ],
  "podSubnetRange": "172.21.0.0/19",
  "providerAccount": "provider-account",
  "secondaryVpcCidr": "<string>",
  "servicePeeringRange": "172.23.0.0/20",
  "serviceSubnetRange": "172.22.0.0/22",
  "tags": [
    {
      "key": "key1",
      "value": "value1"
    }
  ],
  "tenantId": "your-tenant-id",
  "workspaceIds": [
    "clm88rddl000108jwgeka2div"
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500
}

{
  "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

Authorization

string

header

required

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

Path Parameters

organizationId

string

required

The ID of the Organization to which the cluster belongs.

clusterId

string

required

The cluster's ID

Body

application/json

The request body for updating the cluster

Option 1
Option 2

k8sTags

object[]

required

A list of Kubernetes tags to add to the cluster.

Show child attributes

name

string

required

The cluster's name.

Example:

"My cluster"

clusterType

enum<string>

The cluster's type.

Available options:

DEDICATED

Example:

"DEDICATED"

dbInstanceType

string

The cluster's database instance type. Required for Hybrid clusters.

Example:

"Small General Purpose"

enableDr

boolean

Set to false to disable Disaster Recovery. Enabling DR on existing clusters is only supported via the admin API.

isFailedOver

boolean

Whether to trigger a DR failover for the cluster.

nodePools

object[]

A list of node pools to add to the cluster. For Hybrid clusters only.

Show child attributes

workspaceIds

string[]

The list of Workspaces that are authorized to the cluster. If this value is not provided, the existing list of Workspaces remains. If this value is '[]' then all workspace cluster mappings are removed.

Response

cloudProvider

enum<string>

required

The name of the cluster's cloud provider.

Available options:

AWS,

AZURE,

GCP

Example:

"AWS"

createdAt

string<date-time>

required

The time when the cluster was created in UTC. formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

dbInstanceType

string

required

The type of database instance that is used for the cluster.

Example:

"db.t3.medium"

drRegion

string

required

The secondary region for Disaster Recovery for the cluster.

Example:

"us-east-1"

string

required

The cluster's ID.

Example:

"clm7k8tgw000008jz97i37y81"

isDrEnabled

boolean

required

Whether Disaster Recovery is enabled on the cluster

name

string

required

The cluster's name.

Example:

"my cluster"

organizationId

string

required

The ID of the Organization that the cluster belongs to.

Example:

"clm88r8hi000008jwhzxu5crg"

region

string

required

The region in which the cluster is created.

Example:

"us-east-1"

status

enum<string>

required

The status of the cluster.

Available options:

CREATING,

CREATED,

CREATE_FAILED,

UPDATE_FAILED,

UPDATING,

ACCESS_DENIED,

UPGRADE_PENDING,

FAILING_OVER,

FAILOVER_FAILED

Example:

"CREATED"

type

enum<string>

required

The type of the cluster.

Available options:

DEDICATED,

HYBRID

Example:

"DEDICATED"

updatedAt

string<date-time>

required

The time when the cluster was last updated in UTC. formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

vpcSubnetRange

string

required

Example:

"172.20.0.0/22"

drSecondaryVpcCidr

string

The secondary CIDR for the DR region. For AWS clusters only.

drVpcSubnetRange

string

The VPC subnet range for the DR region. For AWS clusters only.

enableReplicationTimeControl

boolean

Whether S3 Replication Time Control is enabled for DR.

failoverInProgress

boolean

Whether a failover is currently in progress.

healthStatus

object

Show child attributes

isFailedOver

boolean

Whether the cluster is currently failed over to the DR region.

isLimited

boolean

Whether the cluster is limited.

Example:

false

metadata

object

Show child attributes

nodePools

object[]

The list of node pools that are created in the cluster.

Show child attributes

podSubnetRange

string

The subnet range for Pods. For GCP clusters only.

Example:

"172.21.0.0/19"

providerAccount

string

The provider account ID. For GCP clusters only.

Example:

"provider-account"

secondaryVpcCidr

string

servicePeeringRange

string

The service peering range. For GCP clusters only.

Example:

"172.23.0.0/20"

serviceSubnetRange

string

The service subnet range. For GCP clusters only.

Example:

"172.22.0.0/22"

Astro API v1beta1

Platform API

IAM API

Update a cluster

Authorizations

Path Parameters

Body

Response