Clusters

Create cluster

Create a Redpanda cluster. Returns a long-running operation. For more information, see Use the Control Plane API. To check operation state, call GET /v1/operations/{id}. Refer to Regions for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to create a BYOC cluster.

post/v1/clusters

Request

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

Request body

Example request

{
  "cluster": {
    "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",
    "network_id": "cjcuq79c4vs94fcufc2g",
    "resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42",
    "schema_registry": {
      "mtls": {
        "ca_certificates_pem": [
          "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
        ],
        "principal_mapping_rules": [
          "RULE:.*CN=([^,]+).*/$1/"
        ]
      }
    }
  }
}

Response

Accepted

Changes

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