---
title: "List Control Planes"
url: "https://nov18-dev.movespot.fyi/apis/konnect-mesh-control-plane-manager-0/versions/09f86219-cde6-4c57-9f6a-7d3dfbc494a1/operations/list-mesh-control-planes"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-mesh-control-plane-manager-0/versions/09f86219-cde6-4c57-9f6a-7d3dfbc494a1.md

# List Control Planes

`GET` `/mesh/control-planes`

Operation ID: `list-mesh-control-planes`

Returns an array of control planes objects.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.

## Responses

- `200` - A paginated list response for a collection of control planes.
- `401` - Unauthorized Error
- `403` - Permission denied

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Mesh Control Plane manager
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /mesh/control-planes:
    get:
      operationId: list-mesh-control-planes
      summary: List Control Planes
      description: Returns an array of control planes objects.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListMeshControlPlanesResponse"
        "401":
          $ref: "#/components/responses/MeshControlPlaneUnauthorizedError"
        "403":
          $ref: "#/components/responses/MeshControlPlaneForbiddenError"
      tags:
        - Mesh
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
  responses:
    ListMeshControlPlanesResponse:
      description: A paginated list response for a collection of control planes.
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/MeshControlPlane"
            title: ListMeshControlPlanesResponse
          examples:
            Control Plane Collection:
              value:
                meta:
                  page:
                    size: 1
                    total: 10
                    number: 3
                data:
                  - id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
                    name: Test Control Plane
                    description: A test control plane for exploration.
                    labels:
                      test: "true"
                    created_at: 2022-11-04T20:10:06.927Z
                    updated_at: 2022-11-04T20:10:06.927Z
    MeshControlPlaneUnauthorizedError:
      description: Unauthorized Error
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            Invalid token:
              value:
                status: 401
                type: https://kongapi.info/konnect/unauthenticated
                title: Unauthenticated
                instance: konnect:trace:4497422055499297627
                detail: A valid token is required
    MeshControlPlaneForbiddenError:
      description: Permission denied
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            Invalid token:
              value:
                status: 403
                type: https://kongapi.info/konnect/unauthorized
                title: Forbidden
                instance: konnect:trace:881615734723181661
                detail: Permission denied
  schemas:
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    MeshControlPlane:
      description: a control plane
      type: object
      properties:
        id:
          description: ID of the control plane.
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
          readOnly: true
        name:
          $ref: "#/components/schemas/MeshControlPlaneName"
        description:
          $ref: "#/components/schemas/MeshControlPlaneDescription"
        labels:
          $ref: "#/components/schemas/MeshControlPlaneLabels"
        features:
          $ref: "#/components/schemas/MeshControlPlaneFeatures"
        created_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
          readOnly: true
        updated_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
          readOnly: true
      required:
        - id
        - name
        - updated_at
        - created_at
      title: ControlPlane
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    MeshControlPlaneName:
      description: The name of the control plane.
      type: string
      example: Test control plane
      maxLength: 100
      minLength: 1
      pattern: ^[a-z0-9A-Z]{1}.*$
    MeshControlPlaneDescription:
      type: string
      example: A control plane to handle traffic on development environment.
      maxLength: 250
    MeshControlPlaneLabels:
      description: Labels to facilitate tagged search on control planes. Keys must be
        of length 1-63 characters.
      type: object
      example:
        test: "true"
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
        nullable: true
      maxProperties: 10
      nullable: true
      title: Labels
    MeshControlPlaneFeatures:
      type: array
      items:
        $ref: "#/components/schemas/MeshControlPlaneFeature"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    MeshControlPlaneFeature:
      description: >
        Features to be enabled in the control plane. Currently only defaults are
        supported.
      type: object
      properties:
        type:
          type: string
          enum:
            - MeshCreation
            - HostnameGeneratorCreation
        hostnameGeneratorCreation:
          $ref: "#/components/schemas/MeshControlPlaneFeatureHostnameGenerationCreation"
        meshCreation:
          $ref: "#/components/schemas/MeshControlPlaneFeatureMeshCreation"
      required:
        - type
    MeshControlPlaneFeatureHostnameGenerationCreation:
      properties:
        enabled:
          type: boolean
      required:
        - enabled
    MeshControlPlaneFeatureMeshCreation:
      properties:
        enabled:
          type: boolean
      required:
        - enabled
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
