Serverless Clusters

List Serverless clusters

List Redpanda Serverless clusters. The filter. query string parameters find matching clusters that meet all specified conditions.

get/v1/serverless/clusters

Request

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

Query parameters

read_maskstring
filter.state_instring[]

States of Serverless cluster.

  • STATE_PLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane.
  • STATE_CREATING: Serverless cluster is in the process of having its control plane state created.
  • STATE_READY: Serverless cluster is in execution and accepting external requests.
  • STATE_DELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released.
  • STATE_FAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states.
  • STATE_SUSPENDED: Serverless cluster is in execution but blocks all external requests.
filter.resource_group_idstring

Resource group ID of Serverless cluster.

filter.name_containsstring

Name of cluster. Partial match.

filter.serverless_regionstring

Region in which Serverless cluster is hosted

filter.private_link_idstring

Private link ID of Serverless cluster

page_sizeinteger

Limit the paginated response to a number of items.

page_tokenstring

Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.

Response

OK

next_page_tokenstring

Page Token to fetch the next page. The value can be used as next_page_token in the next call to this endpoint.

Example response

{
  "serverless_clusters": [
    {
      "ai_gateway": {
        "v2_url": "https://d1d9risv0c3i7qbbeoc0.aigw.adp.us-east-1.mpx.prd.cloud.redpanda.com"
      },
      "name": "development-ServerlessCluster",
      "prometheus": {
        "private_url": "https://d1d9risv0c3i7qbbeoc0.metrics.us-east-1.mpx.prd.cloud.redpanda.com/public_metrics",
        "url": "https://d1d9risv0c3i7qbbeoc0.metrics.us-east-1.mpx.prd.cloud.redpanda.com/public_metrics"
      },
      "resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42",
      "serverless_region": "us-east-1"
    }
  ]
}

Changes

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