Control Planes

List Control Planes

Changed on

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

get/v2/control-planes

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

cloud_gatewayboolean

Filter by a boolean value (true/false).

Filters a collection of control-planes.

labelsstring
Example:key:value,existCheck

Filter control planes in the response by associated labels.

sortstring

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').

Example:created_at desc

Sorts a collection of control-planes. Supported sort attributes are:

  • created_at

Response

A paginated list response for a collection of control planes.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "name": "Test Control Plane",
      "description": "A test control plane for exploration.",
      "labels": {
        "env": "test"
      },
      "config": {
        "control_plane_endpoint": "https://acfe5f253f.cp.konghq.com",
        "telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
        "cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
        "auth_type": "pinned_client_certs",
        "proxy_urls": [
          {
            "host": "example.com",
            "port": 443,
            "protocol": "https"
          }
        ]
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 500.00 enum value to the response property for the response status