list_control_planes

Retrieve and filter a list of control planes in your organization, including details like name, type, endpoints, and labels, with options for pagination and sorting.

Instructions

List all control planes in your organization.

INPUT:

pageSize: Number - Number of control planes per page (1-1000, default: 10)
pageNumber: Number (optional) - Page number to retrieve
filterName: String (optional) - Filter control planes by name
filterClusterType: String (optional) - Filter by cluster type (kubernetes, docker, etc.)
filterCloudGateway: Boolean (optional) - Filter by cloud gateway capability
labels: String (optional) - Filter by labels (format: 'key:value,existCheck')
sort: String (optional) - Sort field and direction (e.g. 'name,created_at desc')

OUTPUT:

metadata: Object - Contains pageSize, pageNumber, totalPages, totalCount, filters, sort
controlPlanes: Array - List of control planes with details for each including:
- controlPlaneId: String - Unique identifier for the control plane
- name: String - Display name of the control plane
- description: String - Description of the control plane
- type: String - Type of the control plane
- clusterType: String - Underlying cluster type
- controlPlaneEndpoint: String - URL endpoint for the control plane
- telemetryEndpoint: String - URL endpoint for telemetry
- hasCloudGateway: Boolean - Whether cloud gateway is enabled
- labels: Object - Labels assigned to this control plane
- metadata: Object - Creation and update timestamps
usage: Object - Information about how to use these results

Input Schema

Name	Required	Description
`filterCloudGateway`	No	Filter by cloud gateway capability
`filterClusterType`	No	Filter by cluster type (e.g., 'kubernetes', 'docker')
`filterName`	No	Filter control planes by name (contains)
`labels`	No	Filter by labels (format: 'key:value,existCheck')
`pageNumber`	No	Page number to retrieve
`pageSize`	No	Number of control planes per page
`sort`	No	Sort field and direction (e.g. 'name,created_at desc')

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "filterCloudGateway": {
      "description": "Filter by cloud gateway capability",
      "type": "boolean"
    },
    "filterClusterType": {
      "description": "Filter by cluster type (e.g., 'kubernetes', 'docker')",
      "type": "string"
    },
    "filterName": {
      "description": "Filter control planes by name (contains)",
      "type": "string"
    },
    "labels": {
      "description": "Filter by labels (format: 'key:value,existCheck')",
      "type": "string"
    },
    "pageNumber": {
      "description": "Page number to retrieve",
      "minimum": 1,
      "type": "integer"
    },
    "pageSize": {
      "default": 10,
      "description": "Number of control planes per page",
      "maximum": 1000,
      "minimum": 1,
      "type": "integer"
    },
    "sort": {
      "description": "Sort field and direction (e.g. 'name,created_at desc')",
      "type": "string"
    }
  },
  "type": "object"
}

Kong Konnect MCP Server

list_control_planes

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Kong Konnect MCP Server

Related Tools