List Serverless clusters Run in API Explorer
List Redpanda Serverless clusters. The filter.
query string parameters find matching clusters that meet all specified conditions.
Query parameters
-
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.
Values are
STATE_PLACING
,STATE_CREATING
,STATE_READY
,STATE_DELETING
,STATE_FAILED
, orSTATE_SUSPENDED
. -
Resource group ID of Serverless cluster.
-
Name of cluster. Partial match.
-
Region in which Serverless cluster is hosted
-
Limit the paginated response to a number of items.
-
Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.
GET
/v1/serverless/clusters
curl \
--request GET 'https://api.redpanda.com/v1/serverless/clusters' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"next_page_token": "string",
"serverless_clusters": [
{
"console": {},
"console_url": "string",
"created_at": "2025-05-04T09:42:00Z",
"dataplane_api": {
"url": "string"
},
"id": "string",
"kafka_api": {
"seed_brokers": [
"string"
]
},
"name": "development-ServerlessCluster",
"planned_deletion": {
"delete_after": "2025-05-04T09:42:00Z",
"reason": "string"
},
"private_link": {
"id": "string",
"state": "STATE_DISABLED"
},
"resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42",
"schema_registry": {
"url": "string"
},
"serverless_region": "us-east-1",
"state": "STATE_PLACING",
"updated_at": "2025-05-04T09:42:00Z"
}
]
}
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"
}
Response examples (default)
{
"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"
}