---
title: "List Control Planes"
method: GET
path: "/v2/control-planes"
tags: ["Control Planes"]
---

# List Control Planes

`GET /v2/control-planes`

Returns an array of control plane objects containing information about the Konnect Control Planes.

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `filter` ControlPlaneFilterParameters
  - `id` object — Filter using **one** of the following operators: `eq`, `oeq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
  - `name` object — Filter using **one** of the following operators: `eq`, `neq`, `contains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `neq` string — The field does not match the provided value.
  - `cluster_type` object — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `neq` string — The field does not match the provided value.
    - `oeq` string — The field matches any of the provided values.
  - `cloud_gateway` boolean — Filter by a boolean value (true/false).
- `labels` string
- `sort` string — The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

## Response `200`

A paginated list response for a collection of control planes.

- object
  - `meta` PaginatedMeta, required — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required
  - `data` ControlPlane[], required
    - `id` string, uuid, required — The control plane ID.
    - `name` string, required — The name of the control plane.
    - `description` string, required — The description of the control plane in Konnect.
    - `labels` Labels, required — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
    - `config` object, required — CP configuration object for related access endpoints.
      - `control_plane_endpoint` string, url, required — Control Plane Endpoint.
      - `telemetry_endpoint` string, url, required — Telemetry Endpoint.
      - `cluster_type` 'CLUSTER_TYPE_CONTROL_PLANE' | 'CLUSTER_TYPE_K8S_INGRESS_CONTROLLER' | 'CLUSTER_TYPE_CONTROL_PLANE_GROUP' | 'CLUSTER_TYPE_SERVERLESS' | 'CLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXY' | 'CLUSTER_TYPE_SERVERLESS_V1', required — The ClusterType value of the cluster associated with the Control Plane.
      - `auth_type` 'pinned_client_certs' | 'pki_client_certs', required — The auth type value of the cluster associated with the Runtime Group.
      - `cloud_gateway` boolean, required — Whether the Control Plane can be used for cloud-gateways.
      - `proxy_urls` ProxyURL[], required — Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
        - `host` string, required — Hostname of the proxy URL.
        - `port` integer, required — Port of the proxy URL.
        - `protocol` string, required — Protocol of the proxy URL.
    - `created_at` string, date-time, required — An ISO-8604 timestamp representation of control plane creation date.
    - `updated_at` string, date-time, required — An ISO-8604 timestamp representation of control plane update date.

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Permission denied
- `500` — Internal
- `503` — Service Unavailable

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/f920f418f552/schema)