Create cluster Run in API Explorer

POST /v1/clusters
Auth0

Create a Redpanda cluster. Returns a long-running operation. See Use the Control Plane API for more information. Call GET /v1/operations/{id} to check operation state. 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.

application/json

Body Required

CreateClusterRequest is the request of CreateCluster.

  • cluster object

    Resource describing a Create Cluster.

    Hide cluster attributes Show cluster attributes object
    • aws_private_link object

      AWS PrivateLink specification.

      Hide aws_private_link attributes Show aws_private_link attributes object
      • allowed_principals array[string]

        The ARN of the principals that can access Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).

      • connect_console boolean

        Whether Console is connected in Redpanda AWS Private Link Service.

      • enabled boolean

        Whether Redpanda AWS Private Link Endpoint Service is enabled.

      • http_proxy_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • kafka_api_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • schema_registry_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

    • azure_private_link object
      Hide azure_private_link attributes Show azure_private_link attributes object
      • allowed_subscriptions array[string]

        The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service.

      • connect_console boolean

        Whether Console is connected in Redpanda Azure Private Link Service.

      • enabled boolean

        Enabled controls if Azure Private Link Endpoint Service is enabled.

      • http_proxy_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • kafka_api_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • schema_registry_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

    • cloud_provider string Required

      Cloud provider where resources are created.

      Values are CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_GCP, or CLOUD_PROVIDER_AZURE.

    • cloud_provider_tags object

      Tags placed on cloud resources. A tag is a key value pair. If the cloud provider is GCP and the key 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 provider tag or label. For example, if the key of a tag is "gcp.network-tag.network-tag-foo", the GCP network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes. Note: If a tag is GCP network tag, its value will be ignored. See the official GCP VPC for more details on network tags.

      Hide cloud_provider_tags attribute Show cloud_provider_tags attribute object
      • * string Additional properties
    • cloud_storage object
      Hide cloud_storage attributes Show cloud_storage attributes object
      • aws object
      • azure object
        Hide azure attributes Show azure attributes object
        • allowed_ips array[string]

          List of public IP or IP ranges in CIDR Format.

          • Only IPv4 addresses are allowed.
          • Private IP address ranges as defined in RFC 1918 are not allowed.
          • Private IP address ranges as defined in RFC 6598 are not allowed.
          • Small address ranges using "/31" or "/32" prefix sizes are not supported. These ranges should be configured using individual IP address rules without prefix specified.
          • allowed_ips have no effect on requests originating from the same Azure region as the storage account. Use allowed_subnet_ids to allow same-region requests. Services deployed in the same region as the storage account use private Azure IP addresses for communication. Thus, you cannot allow access to specific Azure services based on their public outbound IP address range.
        • allowed_subnet_ids array[string]

          A list of virtual network subnet ids that are allowed to access the storage account.

      • gcp object
      • skip_destroy boolean
    • cluster_configuration object
      Hide cluster_configuration attribute Show cluster_configuration attribute object
      • custom_properties object
    • connection_type string

      Cluster connection type. Private clusters are not exposed to the internet. For BYOC clusters, Private is best-practice.

      Values are CONNECTION_TYPE_PUBLIC or CONNECTION_TYPE_PRIVATE.

    • customer_managed_resources object

      The cloud resources created by user.

      Hide customer_managed_resources attributes Show customer_managed_resources attributes object
      • aws object

        AWS resources created and managed by user, and required to deploy the Redpanda cluster.

        Hide aws attributes Show aws attributes object
        • agent_instance_profile object Required

          AWS instance profile.

          Hide agent_instance_profile attribute Show agent_instance_profile attribute object
          • arn string Required

            AWS instance profile ARN.

        • cloud_storage_bucket object Required

          AWS storage bucket properties by ARN.

          Hide cloud_storage_bucket attribute Show cloud_storage_bucket attribute object
          • arn string Required

            AWS storage bucket identifier.

        • cluster_security_group object Required

          Security Group identifies AWS security group.

          Hide cluster_security_group attribute Show cluster_security_group attribute object
          • arn string Required

            AWS security group ARN.

        • connectors_node_group_instance_profile object Required

          AWS instance profile.

          Hide connectors_node_group_instance_profile attribute Show connectors_node_group_instance_profile attribute object
          • arn string Required

            AWS instance profile ARN.

        • connectors_security_group object Required

          Security Group identifies AWS security group.

          Hide connectors_security_group attribute Show connectors_security_group attribute object
          • arn string Required

            AWS security group ARN.

        • k8s_cluster_role object Required

          Role identifies AWS role.

          Hide k8s_cluster_role attribute Show k8s_cluster_role attribute object
          • arn string Required

            AWS role ARN.

        • node_security_group object Required

          Security Group identifies AWS security group.

          Hide node_security_group attribute Show node_security_group attribute object
          • arn string Required

            AWS security group ARN.

        • permissions_boundary_policy object Required

          Policy identifies an AWS policy.

          Hide permissions_boundary_policy attribute Show permissions_boundary_policy attribute object
          • arn string Required

            AWS policy ARN.

        • redpanda_agent_security_group object Required

          Security Group identifies AWS security group.

          Hide redpanda_agent_security_group attribute Show redpanda_agent_security_group attribute object
          • arn string Required

            AWS security group ARN.

        • redpanda_connect_node_group_instance_profile object

          AWS instance profile.

          Hide redpanda_connect_node_group_instance_profile attribute Show redpanda_connect_node_group_instance_profile attribute object
          • arn string Required

            AWS instance profile ARN.

        • redpanda_connect_security_group object

          Security Group identifies AWS security group.

          Hide redpanda_connect_security_group attribute Show redpanda_connect_security_group attribute object
          • arn string Required

            AWS security group ARN.

        • redpanda_node_group_instance_profile object Required

          AWS instance profile.

          Hide redpanda_node_group_instance_profile attribute Show redpanda_node_group_instance_profile attribute object
          • arn string Required

            AWS instance profile ARN.

        • redpanda_node_group_security_group object Required

          Security Group identifies AWS security group.

          Hide redpanda_node_group_security_group attribute Show redpanda_node_group_security_group attribute object
          • arn string Required

            AWS security group ARN.

        • utility_node_group_instance_profile object Required

          AWS instance profile.

          Hide utility_node_group_instance_profile attribute Show utility_node_group_instance_profile attribute object
          • arn string Required

            AWS instance profile ARN.

        • utility_security_group object Required

          Security Group identifies AWS security group.

          Hide utility_security_group attribute Show utility_security_group attribute object
          • arn string Required

            AWS security group ARN.

      • azure object

        Azure resources created and managed by user, and required to deploy the Redpanda cluster.

        Hide azure attributes Show azure attributes object
        • cidrs object Required

          Additional CIDRs allocated to Redpanda cluster.

          Hide cidrs attribute Show cidrs attribute object
          • aks_service_cidr string Required

            CIDR used by AKS Kubernetes services.

        • key_vaults object Required

          Azure key vaults used by Redpanda Cluster. All key vaults shall be in redpanda_resource_group.

          Hide key_vaults attributes Show key_vaults attributes object
          • console_vault object Required

            Azure Key Vault.

            Hide console_vault attribute Show console_vault attribute object
            • name string Required
          • management_vault object Required

            Azure Key Vault.

            Hide management_vault attribute Show management_vault attribute object
            • name string Required
        • resource_groups object Required

          Azure resource groups holding the Redpanda cluster resources.

          Hide resource_groups attributes Show resource_groups attributes object
          • iam_resource_group object Required

            Azure Resource Group Specification

            Hide iam_resource_group attribute Show iam_resource_group attribute object
            • name string Required
          • redpanda_resource_group object Required

            Azure Resource Group Specification

            Hide redpanda_resource_group attribute Show redpanda_resource_group attribute object
            • name string Required
          • storage_resource_group object Required

            Azure Resource Group Specification

            Hide storage_resource_group attribute Show storage_resource_group attribute object
            • name string Required
        • security_groups object Required

          Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.

          Hide security_groups attribute Show security_groups attribute object
          • redpanda_security_group object Required

            Azure security group.

            Hide redpanda_security_group attribute Show redpanda_security_group attribute object
            • name string Required
        • tiered_cloud_storage object Required

          Azure Bucket Specification

          Hide tiered_cloud_storage attributes Show tiered_cloud_storage attributes object
          • resource_group object

            Azure Resource Group Specification

            Hide resource_group attribute Show resource_group attribute object
            • name string Required
          • storage_account_name string Required
          • storage_container_name string Required
        • user_assigned_identities object Required

          Azure user assigned identities used by Redpanda cluster. All identities shall be in iam_resource_group.

          Hide user_assigned_identities attributes Show user_assigned_identities attributes object
          • agent_user_assigned_identity object Required

            Azure user assigned identity.

            Hide agent_user_assigned_identity attribute Show agent_user_assigned_identity attribute object
            • name string Required
          • aks_user_assigned_identity object Required

            Azure user assigned identity.

            Hide aks_user_assigned_identity attribute Show aks_user_assigned_identity attribute object
            • name string Required
          • cert_manager_assigned_identity object Required

            Azure user assigned identity.

            Hide cert_manager_assigned_identity attribute Show cert_manager_assigned_identity attribute object
            • name string Required
          • external_dns_assigned_identity object Required

            Azure user assigned identity.

            Hide external_dns_assigned_identity attribute Show external_dns_assigned_identity attribute object
            • name string Required
          • kafka_connect_assigned_identity object Required

            Azure user assigned identity.

            Hide kafka_connect_assigned_identity attribute Show kafka_connect_assigned_identity attribute object
            • name string Required
          • redpanda_cluster_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_cluster_assigned_identity attribute Show redpanda_cluster_assigned_identity attribute object
            • name string Required
          • redpanda_connect_api_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_connect_api_assigned_identity attribute Show redpanda_connect_api_assigned_identity attribute object
            • name string Required
          • redpanda_connect_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_connect_assigned_identity attribute Show redpanda_connect_assigned_identity attribute object
            • name string Required
          • redpanda_console_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_console_assigned_identity attribute Show redpanda_console_assigned_identity attribute object
            • name string Required
          • redpanda_operator_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_operator_assigned_identity attribute Show redpanda_operator_assigned_identity attribute object
            • name string Required
      • gcp object

        GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP.

        Hide gcp attributes Show gcp attributes object
        • agent_service_account object Required

          GCP service account.

          Hide agent_service_account attribute Show agent_service_account attribute object
          • email string Required

            GCP service account email.

        • connector_service_account object Required

          GCP service account.

          Hide connector_service_account attribute Show connector_service_account attribute object
          • email string Required

            GCP service account email.

        • console_service_account object Required

          GCP service account.

          Hide console_service_account attribute Show console_service_account attribute object
          • email string Required

            GCP service account email.

        • gke_service_account object Required

          GCP service account.

          Hide gke_service_account attribute Show gke_service_account attribute object
          • email string Required

            GCP service account email.

        • psc_nat_subnet_name string

          NAT subnet name if GCP Private Service Connect (a.k.a Private Link) is enabled. If it is used for PSC v1, use psc_v2_nat_subnet_name to set NAT subnet name for PSC v2.

        • psc_v2_nat_subnet_name string

          NAT subnet name for PSC v2 if GCP Private Service Connect (a.k.a Private Link) is enabled and psc_nat_subnet_name is used for PSC v1.

        • redpanda_cluster_service_account object Required

          GCP service account.

          Hide redpanda_cluster_service_account attribute Show redpanda_cluster_service_account attribute object
          • email string Required

            GCP service account email.

        • redpanda_connect_api_service_account object Required

          GCP service account.

          Hide redpanda_connect_api_service_account attribute Show redpanda_connect_api_service_account attribute object
          • email string Required

            GCP service account email.

        • redpanda_connect_service_account object Required

          GCP service account.

          Hide redpanda_connect_service_account attribute Show redpanda_connect_service_account attribute object
          • email string Required

            GCP service account email.

        • redpanda_operator_service_account object

          GCP service account.

          Hide redpanda_operator_service_account attribute Show redpanda_operator_service_account attribute object
          • email string Required

            GCP service account email.

        • subnet object Required

          GCP subnet properties. See the official GCP API reference.

          Hide subnet attributes Show subnet attributes object
          • k8s_master_ipv4_range string Required

            Kubernetes Master IPv4 range, e.g. 10.0.0.0/24.

          • name string Required

            Subnet name.

          • secondary_ipv4_range_pods object Required

            Secondary IPv4 range.

            Hide secondary_ipv4_range_pods attribute Show secondary_ipv4_range_pods attribute object
            • name string
          • secondary_ipv4_range_services object Required

            Secondary IPv4 range.

            Hide secondary_ipv4_range_services attribute Show secondary_ipv4_range_services attribute object
            • name string
        • tiered_storage_bucket object Required

          GCP storage bucket properties.

          Hide tiered_storage_bucket attribute Show tiered_storage_bucket attribute object
          • name string Required

            Name of GCP storage bucket. See the official GCP documentation for naming restrictions.

    • gcp_enable_global_access boolean
    • gcp_private_service_connect object
      Hide gcp_private_service_connect attributes Show gcp_private_service_connect attributes object
      • consumer_accept_list array[object]

        List of consumers that are allowed to connect to Redpanda GCP PSC (Private Service Connect) service attachment.

        GCP Private Service Connect consumer specifications.

        Hide consumer_accept_list attribute Show consumer_accept_list attribute object
        • source string

          Either the GCP project number or its alphanumeric ID.

      • enabled boolean

        Whether Redpanda GCP Private Service Connect is enabled.

      • global_access_enabled boolean

        Whether global access is enabled.

      • http_proxy_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • kafka_api_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • schema_registry_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

    • http_proxy object

      Cluster's HTTP Proxy properties. See Use Redpanda with the HTTP Proxy API and the HTTP Proxy API reference for more information.

      Hide http_proxy attributes Show http_proxy attributes object
      • mtls object

        mTLS configuration.

        Hide mtls attributes Show mtls attributes object
        • ca_certificates_pem array[string]

          CA certificate in PEM format.

        • enabled boolean

          Whether mTLS is enabled.

        • principal_mapping_rules array[string]

          Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.

      • sasl object
        Hide sasl attribute Show sasl attribute object
        • enabled boolean

          Whether SASL is enabled.

    • kafka_api object

      Cluster's Kafka API properties.

      Hide kafka_api attributes Show kafka_api attributes object
      • mtls object

        mTLS configuration.

        Hide mtls attributes Show mtls attributes object
        • ca_certificates_pem array[string]

          CA certificate in PEM format.

        • enabled boolean

          Whether mTLS is enabled.

        • principal_mapping_rules array[string]

          Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.

      • sasl object
        Hide sasl attribute Show sasl attribute object
        • enabled boolean

          Whether SASL is enabled.

    • kafka_connect object
      Hide kafka_connect attribute Show kafka_connect attribute object
      • enabled boolean
    • maintenance_window_config object

      Resource describing the maintenance window configuration of a cluster.

      Hide maintenance_window_config attributes Show maintenance_window_config attributes object
      • anytime object
      • day_hour object
        Hide day_hour attributes Show day_hour attributes object
        • day_of_week string

          Represents a day of the week.

          • MONDAY: Monday
          • TUESDAY: Tuesday
          • WEDNESDAY: Wednesday
          • THURSDAY: Thursday
          • FRIDAY: Friday
          • SATURDAY: Saturday
          • SUNDAY: Sunday

          Values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.

        • hour_of_day integer(int32)
      • unspecified object
    • name string Required

      Unique name of the cluster.

    • network_id string Required

      Id of the network where the cluster will be placed.

    • read_replica_cluster_ids array[string]

      IDs of clusters that can create read-only topics from this cluster.

    • redpanda_version string | null

      Cluster's Redpanda version. Only major.minor semver is supported, e.g. 24.1.

    • region string Required

      Cloud provider region where the cluster will be provisioned.

    • resource_group_id string Required

      Resource group ID of the cluster

    • schema_registry object

      Cluster's Schema Registry properties. See the Schema Registry overview and the Schema Registry API reference for more information.

      Hide schema_registry attributes Show schema_registry attributes object
      • mtls object

        mTLS configuration.

        Hide mtls attributes Show mtls attributes object
        • ca_certificates_pem array[string]

          CA certificate in PEM format.

        • enabled boolean

          Whether mTLS is enabled.

        • principal_mapping_rules array[string]

          Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.

      • sasl object
        Hide sasl attribute Show sasl attribute object
        • enabled boolean

          Whether SASL is enabled.

    • throughput_tier string Required

      Throughput tier of the cluster. See also: Redpanda Cloud Dedicated tiers and BYOC tiers.

    • type string Required

      Cluster type. Type is immutable and can only be set on cluster creation.

      Values are TYPE_DEDICATED or TYPE_BYOC.

    • zones array[string] Required

      Cloud provider zones. Must be valid zones within the selected region. If multiple zones are used, the cluster is a multi-AZ cluster.

Responses

  • 202 application/json

    Accepted

    Hide response attribute Show response attribute object
    • operation object

      Operation describes a long running operation

      Hide operation attributes Show operation attributes object
      • error object

        Describes errors

        Hide error attributes Show error attributes object
        • code string(int32)

          RPC status code, as described here.

          Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

        • details array[object]

          A list of messages that carries the error details.

          Details of the error.

          Details of the error.

          One of:
          BadRequest object ErrorInfo object QuotaFailure object Help object
        • message string

          Detailed error message. No compatibility guarantees are given for the text contained in this message.

      • finished_at string(date-time)

        Timestamp when the operation has finished.

      • id string

        ID of the operation.

      • metadata object

        Metadata of the long-running Operation. Contains in-progress information.

        One of:
        CreateNetworkMetadata object object-1 object CreateClusterMetadata object UpdateClusterMetadata object DeleteClusterMetadata object
      • resource_id string | null

      • response object

        Response of the long-running Operation.

        One of:
        CreateClusterResponse object UpdateClusterResponse object object-1 object CreateNetworkResponse object object-1 object
      • started_at string(date-time)

        Timestamp when the operation has started.

      • state string

        describes if the operation has finished, or is still in progress. Only if done is true, either error or result become available.

        Values are STATE_IN_PROGRESS, STATE_COMPLETED, or STATE_FAILED.

      • type string

        Values are TYPE_CREATE_CLUSTER, TYPE_UPDATE_CLUSTER, TYPE_DELETE_CLUSTER, TYPE_CREATE_NETWORK, TYPE_DELETE_NETWORK, TYPE_CREATE_SERVERLESS_CLUSTER, TYPE_DELETE_SERVERLESS_CLUSTER, TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES, or TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES.
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
      BadRequest object ErrorInfo object QuotaFailure object Help object
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.
  • 409 application/json

    Conflict

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
      BadRequest object ErrorInfo object QuotaFailure object Help object
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.
  • 500 application/json

    Internal Server Error. Please reach out to support.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
      BadRequest object ErrorInfo object QuotaFailure object Help object
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.
POST /v1/clusters 
curl \
 --request POST 'https://api.redpanda.com/v1/clusters' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"my-new-cluster","type":"TYPE_DEDICATED","zones":["us-west1-a","us-west1-b","us-west1-c"],"region":"us-west1","network_id":"cjb69k1c4vs45df9bee0","cloud_provider":"CLOUD_PROVIDER_GCP","connection_type":"CONNECTION_TYPE_PUBLIC","throughput_tier":"tier-1-gcp-um4g","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47"}'
Request example 
{
  "name": "my-new-cluster",
  "type": "TYPE_DEDICATED",
  "zones": [
    "us-west1-a",
    "us-west1-b",
    "us-west1-c"
  ],
  "region": "us-west1",
  "network_id": "cjb69k1c4vs45df9bee0",
  "cloud_provider": "CLOUD_PROVIDER_GCP",
  "connection_type": "CONNECTION_TYPE_PUBLIC",
  "throughput_tier": "tier-1-gcp-um4g",
  "resource_group_id": "6c09e47b-f426-4ec7-a7b4-8048caf8ae47"
}
Response examples (202) 
{
  "operation": {
    "id": "cjb5uh9c4vs1td8emmcg",
    "type": "TYPE_CREATE_CLUSTER",
    "state": "STATE_IN_PROGRESS",
    "metadata": {
      "@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata",
      "cluster_id": "cjb5vehc4vs19qc11pjg"
    },
    "started_at": null,
    "finished_at": null,
    "resource_id": "cjb5vehc4vs19qc11pjg"
  }
}
Response examples (400)
404 
{
  "code": "INVALID_ARGUMENT",
  "message": "Invalid Request"
}
Invalid Cluster Type 
{
  "code": "INVALID_ARGUMENT",
  "message": "Invalid Request"
}
Response examples (409)
Conflict 
{
  "code": "ALREADY_EXISTS",
  "message": "Cluster with given name already exists"
}
Response examples (500)
Internal Server Error 
{
  "code": "INTERNAL",
  "message": "Internal Server Error"
}