---
title: "CustomDomainsFilterParameters"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/fec2814b-b34b-4614-bacd-b3f0b84c6195/schemas/CustomDomainsFilterParameters"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/fec2814b-b34b-4614-bacd-b3f0b84c6195.md

# CustomDomainsFilterParameters

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 3.0.0
servers:
  - url: https://global.api.konghq.com/v3
    description: Base URL for the global region
components:
  schemas:
    IDFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/StringFieldEqualsFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
      title: IDFieldFilter
    ControlPlaneGeoFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeoFieldEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldNotEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldOrEqualityFilter"
      title: ControlPlaneGeoFieldFilter
    CloudGatewaysStringFieldFilterOverride:
      oneOf:
        - $ref: "#/components/schemas/CloudGatewaysStringFieldEqualsFilterOverride"
        - $ref: "#/components/schemas/StringFieldContainsFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
        - $ref: "#/components/schemas/StringFieldOContainsFilter"
      title: CloudGatewaysStringFieldFilterOverride
    CustomDomainStateFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/CustomDomainStateFieldEqualsFilter"
        - $ref: "#/components/schemas/CustomDomainStateFieldNotEqualsFilter"
        - $ref: "#/components/schemas/CustomDomainStateFieldOrEqualityFilter"
      title: CustomDomainStateFieldFilter
    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
    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
    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
    ControlPlaneGeoFieldEqualsFilter:
      description: Filter a control-plane geo by exact match.
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeo"
        - type: object
          title: ControlPlaneGeoFieldEqualsComparison
          properties:
            eq:
              $ref: "#/components/schemas/ControlPlaneGeo"
          required:
            - eq
      title: ControlPlaneGeoFieldEqualsFilter
      x-examples:
        example-1: us
        example-2:
          eq: us
    ControlPlaneGeoFieldNotEqualsFilter:
      description: Filter a control-plane geo by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/ControlPlaneGeo"
      required:
        - neq
      title: ControlPlaneGeoFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: us
    ControlPlaneGeoFieldOrEqualityFilter:
      description: >
        Filter a control-plane geo by determining if the value is equal to any
        in a set of values, where the set is a

        comma-delimited list.
      type: object
      properties:
        oeq:
          type: string
      required:
        - oeq
      title: ControlPlaneGeoFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: us,eu
    CloudGatewaysStringFieldEqualsFilterOverride:
      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
    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
    StringFieldOContainsFilter:
      description: Returns entities that fuzzy-match any of the comma-delimited
        phrases in the filter string.
      type: object
      properties:
        ocontains:
          type: string
      additionalProperties: false
      required:
        - ocontains
      title: StringFieldOContainsFilter
      x-examples:
        example-1:
          ocontains: this-value,or-that-value
    CustomDomainStateFieldEqualsFilter:
      description: Filter custom domain state by exact match.
      oneOf:
        - $ref: "#/components/schemas/CustomDomainState"
        - type: object
          title: CustomDomainStateFieldEqualsComparison
          properties:
            eq:
              $ref: "#/components/schemas/CustomDomainState"
          required:
            - eq
      title: CustomDomainStateFieldEqualsFilter
    CustomDomainStateFieldNotEqualsFilter:
      description: Filter custom domain state by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/CustomDomainState"
      required:
        - neq
      title: CustomDomainStateFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: ready
    CustomDomainStateFieldOrEqualityFilter:
      description: >
        Filter custom domain state by determining if the value is equal to any
        in a set of values, where the set is a

        comma-delimited list.
      type: object
      properties:
        oeq:
          type: string
      required:
        - oeq
      title: CustomDomainStateFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: ready,initializing
    ControlPlaneGeo:
      description: Set of control-plane geos supported for deploying cloud-gateways
        configurations.
      type: string
      enum:
        - us
        - eu
        - au
        - me
        - in
        - sg
      title: Control-Plane Geo
    CustomDomainState:
      description: State of the custom domain.
      type: string
      enum:
        - created
        - initializing
        - ready
        - terminating
        - terminated
        - error
      readOnly: true
      title: Custom Domain State
    CustomDomainsFilterParameters:
      type: object
      properties:
        control_plane_id:
          $ref: "#/components/schemas/IDFieldFilter"
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeoFieldFilter"
        domain:
          $ref: "#/components/schemas/CloudGatewaysStringFieldFilterOverride"
        state:
          $ref: "#/components/schemas/CustomDomainStateFieldFilter"
      additionalProperties: false
      title: CustomDomainsFilterParameters
```
