Clusters

Update cluster

Update a Redpanda cluster.

patch/v1/clusters/{cluster.id}

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/clusters/{cluster.id}
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Path parameters

cluster.idstring required

ID of the cluster.

Request body

api_gateway_access'NETWORK_ACCESS_MODE_PRIVATE' | 'NETWORK_ACCESS_MODE_PUBLIC'

Network access mode for an endpoint.

cloud_provider_tagsobject

Tags that are placed on Cloud resources. If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag is a normal tag. For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes. Note: The value of a network tag will be ignored. See the official GCP VPC for more details on network tags.

gcp_enable_global_access_api_gatewayboolean

gcp_enable_global_access_api_gateway controls if global access is enabled on the internal load balancer serving the Console/API Gateway endpoint. Applicable only for GCP. Default is false. Maps to enable_global_access_console in the internal RedpandaSpec connectivity spec.

namestring

Unique name of the cluster.

read_replica_cluster_idsstring[]

IDs of clusters which may create read-only topics from this cluster.

redpanda_node_countinteger
throughput_tierstring

Example request

{
  "aws_private_link": {
    "allowed_principals": [
      "arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root"
    ],
    "supported_regions": [
      "us-east-1",
      "us-west-2"
    ]
  },
  "azure_private_link": {
    "allowed_subscriptions": [
      "4a73b02e-90c1-4d76-af36-5c935dd41e7c"
    ]
  },
  "gcp_private_service_connect": {
    "consumer_accept_list": [
      {
        "source": "gcp-project-1"
      }
    ]
  },
  "http_proxy": {
    "mtls": {
      "ca_certificates_pem": [
        "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
      ],
      "principal_mapping_rules": [
        "RULE:.*CN=([^,]+).*/$1/"
      ]
    }
  },
  "kafka_api": {
    "mtls": {
      "ca_certificates_pem": [
        "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
      ],
      "principal_mapping_rules": [
        "RULE:.*CN=([^,]+).*/$1/"
      ]
    }
  },
  "name": "development-cluster",
  "schema_registry": {
    "mtls": {
      "ca_certificates_pem": [
        "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
      ],
      "principal_mapping_rules": [
        "RULE:.*CN=([^,]+).*/$1/"
      ]
    }
  }
}

Response

Accepted

api_gateway_access'NETWORK_ACCESS_MODE_PRIVATE' | 'NETWORK_ACCESS_MODE_PUBLIC'

Network access mode for an endpoint.

cloud_provider_tagsobject

Tags that are placed on Cloud resources. If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag is a normal tag. For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes. Note: The value of a network tag will be ignored. See the official GCP VPC for more details on network tags.

gcp_enable_global_access_api_gatewayboolean

gcp_enable_global_access_api_gateway controls if global access is enabled on the internal load balancer serving the Console/API Gateway endpoint. Applicable only for GCP. Default is false. Maps to enable_global_access_console in the internal RedpandaSpec connectivity spec.

idstring required

ID of the cluster.

namestring

Unique name of the cluster.

read_replica_cluster_idsstring[]

IDs of clusters which may create read-only topics from this cluster.

redpanda_node_countinteger
throughput_tierstring

Example response

{
  "aws_private_link": {
    "allowed_principals": [
      "arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root"
    ],
    "supported_regions": [
      "us-east-1",
      "us-west-2"
    ]
  },
  "azure_private_link": {
    "allowed_subscriptions": [
      "4a73b02e-90c1-4d76-af36-5c935dd41e7c"
    ]
  },
  "gcp_private_service_connect": {
    "consumer_accept_list": [
      {
        "source": "gcp-project-1"
      }
    ]
  },
  "http_proxy": {
    "mtls": {
      "ca_certificates_pem": [
        "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
      ],
      "principal_mapping_rules": [
        "RULE:.*CN=([^,]+).*/$1/"
      ]
    }
  },
  "kafka_api": {
    "mtls": {
      "ca_certificates_pem": [
        "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
      ],
      "principal_mapping_rules": [
        "RULE:.*CN=([^,]+).*/$1/"
      ]
    }
  },
  "name": "development-cluster",
  "schema_registry": {
    "mtls": {
      "ca_certificates_pem": [
        "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
      ],
      "principal_mapping_rules": [
        "RULE:.*CN=([^,]+).*/$1/"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.