Create network Run in API Explorer

POST /v1/networks
Auth0

Create a Redpanda network. Returns a long-running operation. See Use the Control Plane API for more information. Call GET /v1/operations/{id} to check operation state.

application/json

Body Required

CreateNetworkRequest is the request of CreateNetwork.

  • network object Required

    Redpanda Cloud network properties.

    Hide network attributes Show network attributes object
    • cidr_block string

      Network CIDR from where public and private subnets are derived. At least a 21 bits CIDR is required. For more information, see Choose CIDR Ranges.

    • cloud_provider string Required

      Cloud provider where resources are created.

      Values are CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_GCP, or CLOUD_PROVIDER_AZURE.

    • cluster_type string Required

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

      Values are TYPE_DEDICATED or TYPE_BYOC.

    • customer_managed_resources object

      Cloud resources created by user.

      Hide customer_managed_resources attributes Show customer_managed_resources attributes object
      • aws object

        The AWS resources managed by user.

        Hide aws attributes Show aws attributes object
        • dynamodb_table object Required

          AWS DynamoDB table specification.

          Hide dynamodb_table attribute Show dynamodb_table attribute object
          • arn string Required

            AWS DynamoDB table identifier.

        • management_bucket object Required

          AWS storage bucket properties by ARN.

          Hide management_bucket attribute Show management_bucket attribute object
          • arn string Required

            AWS storage bucket identifier.

        • private_subnets object Required

          AWS Subnets Specification

          Hide private_subnets attribute Show private_subnets attribute object
          • arns array[string] Required

            AWS subnet identifiers.

        • vpc object Required

          AWS VPC Specification

          Hide vpc attribute Show vpc attribute object
          • arn string Required

            AWS VPC identifier.

      • azure object

        The Azure resources managed by user.

        Hide azure attributes Show azure attributes object
        • management_bucket object Required

          Azure Bucket Specification

          Hide management_bucket attributes Show management_bucket 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
        • subnets object Required

          Azure subnets used by Redpand cluster deployment.

          Hide subnets attributes Show subnets attributes object
          • kafka_connect_pods object Required

            Azure subnet.

            Hide kafka_connect_pods attribute Show kafka_connect_pods attribute object
            • name string Required
          • kafka_connect_vnet object Required

            Azure subnet.

            Hide kafka_connect_vnet attribute Show kafka_connect_vnet attribute object
            • name string Required
          • rp_0_pods object Required

            Azure subnet.

            Hide rp_0_pods attribute Show rp_0_pods attribute object
            • name string Required
          • rp_0_vnet object Required

            Azure subnet.

            Hide rp_0_vnet attribute Show rp_0_vnet attribute object
            • name string Required
          • rp_1_pods object Required

            Azure subnet.

            Hide rp_1_pods attribute Show rp_1_pods attribute object
            • name string Required
          • rp_1_vnet object Required

            Azure subnet.

            Hide rp_1_vnet attribute Show rp_1_vnet attribute object
            • name string Required
          • rp_2_pods object Required

            Azure subnet.

            Hide rp_2_pods attribute Show rp_2_pods attribute object
            • name string Required
          • rp_2_vnet object Required

            Azure subnet.

            Hide rp_2_vnet attribute Show rp_2_vnet attribute object
            • name string Required
          • rp_agent object Required

            Azure subnet.

            Hide rp_agent attribute Show rp_agent attribute object
            • name string Required
          • rp_connect_pods object Required

            Azure subnet.

            Hide rp_connect_pods attribute Show rp_connect_pods attribute object
            • name string Required
          • rp_connect_vnet object Required

            Azure subnet.

            Hide rp_connect_vnet attribute Show rp_connect_vnet attribute object
            • name string Required
          • rp_egress_vnet object Required

            Azure subnet.

            Hide rp_egress_vnet attribute Show rp_egress_vnet attribute object
            • name string Required
          • sys_pods object Required

            Azure subnet.

            Hide sys_pods attribute Show sys_pods attribute object
            • name string Required
          • sys_vnet object Required

            Azure subnet.

            Hide sys_vnet attribute Show sys_vnet attribute object
            • name string Required
        • vnet object Required

          Azure VNET.

          Hide vnet attributes Show vnet attributes object
          • name string Required
          • resource_group object Required

            Azure Resource Group Specification

            Hide resource_group attribute Show resource_group 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 for details.

        Hide gcp attributes Show gcp attributes object
        • management_bucket object Required

          GCP storage bucket properties.

          Hide management_bucket attribute Show management_bucket attribute object
          • name string Required

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

        • network_name string Required

          Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.

        • network_project_id string Required

          GCP project ID where the network is created.

    • name string

      The unique name of the network.

    • region string Required

      Cloud provider region. See available cloud providers and regions.

    • resource_group_id string Required

      Resource group ID of the network

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/networks 
curl \
 --request POST 'https://api.redpanda.com/v1/networks' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"my-network","region":"us-west1","cidr_block":"10.0.0.0/20","cluster_type":"TYPE_DEDICATED","cloud_provider":"CLOUD_PROVIDER_GCP","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47"}'
Request example 
{
  "name": "my-network",
  "region": "us-west1",
  "cidr_block": "10.0.0.0/20",
  "cluster_type": "TYPE_DEDICATED",
  "cloud_provider": "CLOUD_PROVIDER_GCP",
  "resource_group_id": "6c09e47b-f426-4ec7-a7b4-8048caf8ae47"
}
Response examples (202) 
{
  "operation": {
    "id": "cjd55r9c4vsao59ucoqg",
    "type": "TYPE_CREATE_NETWORK",
    "state": "STATE_IN_PROGRESS",
    "metadata": {
      "@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata",
      "network_id": "cjd533pc4vs8pjdkrrv0"
    },
    "started_at": null,
    "finished_at": null,
    "resource_id": "cjd533pc4vs8pjdkrrv0"
  }
}
Response examples (400) 
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (409) 
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (500) 
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}