---
title: "ControlPlaneFilterParameters"
url: "https://seriousmonkeybusiness.shermett.me/apis/konnect-control-planes-2/versions/cdbfd644-3e35-4ab1-acfb-99cb9b2d34ed/schemas/ControlPlaneFilterParameters"
---

> Full API specification: https://seriousmonkeybusiness.shermett.me/apis/konnect-control-planes-2/versions/cdbfd644-3e35-4ab1-acfb-99cb9b2d34ed.md

# ControlPlaneFilterParameters

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
components:
  schemas:
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      oneOf:
        - type: string
        - type: object
          title: StringFieldEqualsComparison
          additionalProperties: false
          properties:
            eq:
              type: string
          required:
            - eq
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    StringFieldOEQFilter:
      description: Returns entities that exact match any of the comma-delimited
        phrases in the filter string.
      type: object
      properties:
        oeq:
          type: string
      additionalProperties: false
      required:
        - oeq
      title: StringFieldOEQFilter
      x-examples:
        example-1:
          oeq: some-value,some-other-value
    StringFieldContainsFilter:
      description: Filters on the given string field value by fuzzy match.
      type: object
      properties:
        contains:
          type: string
      additionalProperties: false
      required:
        - contains
      title: StringFieldContainsFilter
      x-examples:
        example-1:
          contains: some-value
    StringFieldNEQFilter:
      description: Filters on the given string field value by exact match inequality.
      type: object
      properties:
        neq:
          type: string
      additionalProperties: false
      required:
        - neq
      title: StringFieldNEQFilter
      x-examples:
        example-1:
          neq: not-this-value
    BooleanFieldFilter:
      description: Filter by a boolean value (true/false).
      type: boolean
      title: BooleanFieldFilter
      x-examples:
        example-1: true
    ControlPlaneFilterParameters:
      type: object
      properties:
        id:
          oneOf:
            - $ref: "#/components/schemas/StringFieldEqualsFilter"
            - $ref: "#/components/schemas/StringFieldOEQFilter"
        name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldEqualsFilter"
            - $ref: "#/components/schemas/StringFieldContainsFilter"
            - $ref: "#/components/schemas/StringFieldNEQFilter"
        cluster_type:
          oneOf:
            - $ref: "#/components/schemas/StringFieldEqualsFilter"
            - $ref: "#/components/schemas/StringFieldNEQFilter"
        cloud_gateway:
          $ref: "#/components/schemas/BooleanFieldFilter"
      additionalProperties: false
      title: ControlPlaneFilterParameters
```