# ListKafkaConnections

**POST /redpanda.core.admin.v2.ClusterService/ListKafkaConnections**

Returns information about the cluster's Kafka connections, collected and ordered across all brokers.


## Servers
- http://localhost:9644: http://localhost:9644 ()



## Parameters
#### Headers
- **Connect-Protocol-Version** (number)
  Define the version of the Connect protocol
- **Connect-Timeout-Ms** (number)
  Define the timeout, in ms



## Body parameters
Content-type: application/json

- **filter** (string)
  Filter expression to apply to the connection list.
 Uses a subset of AIP-160 filter syntax supporting:
 - Field comparisons (`=`, `!=`, `<`, `>`, `<=`, `>=`)
 - Logical AND chaining: condition1 AND condition2
 - Nested field access: parent.child = value
 - Escape sequences: field = "string with \"quotes\""
 - Enum types
 - RFC3339 timestamps and ISO-like duration

 Limitations (not supported):
 - Logical OR chaining
 - Parentheses `(` `)` for grouping
 - Map and repeated types
 - HAS (:) operator
 - Negation (-, NOT)
 - Bare literal matching

 Example filters:
 - `state = KAFKA_CONNECTION_STATE_OPEN`
 - `idle_duration > 30s AND total_request_statistics.request_count > 100`
 - `authentication_info.user_principal = "my-producer"`
 - `recent_request_statistics.produce_bytes > 1000 AND
 client_software_name = "kgo"`
 - `open_time >= 2025-09-01T10:22:54Z`

 Reference: https://google.aip.dev/160
- **orderBy** (string)
  Field-based ordering specification following AIP-132 syntax.
 Supports multiple fields with `asc`/`desc` direction indicators.
 Examples:
 - `idle_duration desc` - longest idle connections first
 - `open_time desc, total_request_statistics.request_count desc` - newest
 connections first, then most active
 - `recent_request_statistics.produce_bytes desc` - connections with
 highest current produce throughput first

 Reference: https://google.aip.dev/132#ordering
- **pageSize** (integer(int32))
  The maximum number of connections to return. If unspecified or 0, a
 default value may be applied. The server may return fewer connections
 than requested due to memory constraints; the limit is set to allow
 listing all connections for a single broker. Consider filtering by
 node_id to view connections for specific brokers. Note that paging is
 currently not fully supported, and this field only acts as a limit for
 the first page of data returned. Subsequent pages of data cannot be
 requested.

## Responses
### 200: Success

#### Body Parameters: application/json (object)
- **connections** (array[object])
  The list of connections matching the request.
 Note that in addition to open connections, some recently-closed
 connections may also be included here. If you don't want to include
 closed connections, set the filter in the request to `state =
 KAFKA_CONNECTION_STATE_OPEN`.
- **totalSize** (integer | string)
  Total number of connections matching the request.
 This may be greater than `len(connections)` if some connections were
 omitted from the response due to the specified (or default) `page_size`.
 Example:
   request.page_size = 10
   response.connections = [<10 items>]
   response.total_size = 13

### default: Error

#### Body Parameters: application/json (object)
- **code** (string)
  The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- **details** (array[object])
  A list of messages that carry the error details. There is no limit on the number of messages.
- **message** (string)
  A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.


[Powered by Bump.sh](https://bump.sh)