POST /v1/serverless/clusters
Auth0

Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see Use the Control Plane API. To check operation state, call GET /v1/operations/{id}.

application/json

Body Required

CreateServerlessClusterRequest is the request of CreateServerlessCluster.

  • serverless_cluster object

    Resource describing a Create ServerlessCluster.

    Hide serverless_cluster attributes Show serverless_cluster attributes object
    • name string Required

      Unique name of the Serverless cluster within the org.

    • networking_config object
      Hide networking_config attributes Show networking_config attributes object
      • private string

        Values are STATE_DISABLED or STATE_ENABLED.

      • public string

        Values are STATE_DISABLED or STATE_ENABLED.

    • private_link_id string | null

      Private link configuration for the Serverless cluster.

    • resource_group_id string Required

      Resource group ID of the cluster.

    • serverless_region string Required

      Name of the region where the Serverless cluster will be provisioned.

    • tags object
      Hide tags attribute Show tags attribute object
      • * string Additional properties

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 CreateNetworkPeeringMetadata object object-1 object object-1 object CreateServerlessClusterMetadata object object-1 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 CreateNetworkPeeringResponse object object-1 object object-1 object CreateServerlessClusterResponse 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, TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES, TYPE_CREATE_SERVERLESS_PRIVATE_LINK, TYPE_UPDATE_SERVERLESS_PRIVATE_LINK, TYPE_DELETE_SERVERLESS_PRIVATE_LINK, TYPE_CREATE_NETWORK_PEERING, TYPE_DELETE_NETWORK_PEERING, TYPE_CREATE_SHADOW_LINK, TYPE_UPDATE_SHADOW_LINK, or TYPE_DELETE_SHADOW_LINK.
  • 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/serverless/clusters 
curl \
 --request POST 'https://api.redpanda.com/v1/serverless/clusters' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"serverless_cluster":{"name":"my-serverless-cluster","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","serverless_region":"us-east-1"}}'
Request example 
{
  "serverless_cluster": {
    "name": "my-serverless-cluster",
    "resource_group_id": "6c09e47b-f426-4ec7-a7b4-8048caf8ae47",
    "serverless_region": "us-east-1"
  }
}
Response examples (202) 
{
  "operation": {
    "id": "cjsl7h9c4vs1td8emmcg",
    "type": "TYPE_CREATE_SERVERLESS_CLUSTER",
    "state": "STATE_IN_PROGRESS",
    "metadata": {
      "@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateServerlessClusterMetadata",
      "serverless_cluster_id": "d1d9risv0c3i7qbbeoc0"
    },
    "started_at": null,
    "finished_at": null,
    "resource_id": "d1d9risv0c3i7qbbeoc0"
  }
}
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"
}

Documentation preview

will expire on January 23 at 13:11

This is a preview of your version @2026-01-16.

View current documentation