Mesh

List Control Planes

Returns an array of control planes objects.

get/v1/mesh/control-planes

Query parameters

page[size]integer
Example:100

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.

Filters a collection of control planes.

Response

A paginated list response for a collection of control planes.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
      "name": "Test control plane",
      "description": "A control plane to handle traffic on development environment.",
      "labels": {
        "test": "true"
      },
      "version": "v3",
      "created_at": "2023-01-11T02:30:42.227Z",
      "updated_at": "2023-01-11T02:30:42.227Z"
    }
  ]
}

Changes

Changed in 2 of the 29 revisions of this API.3

    • added the new optional query request parameter filter

      new-optional-request-parameter

    • added the optional property data/items/version to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added