---
title: "CustomDomainsFilterParameters"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/schemas/CustomDomainsFilterParameters"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# CustomDomainsFilterParameters

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
components:
  schemas:
    IDFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
      additionalProperties: false
      x-examples:
        example-1:
          neq: not-this-value
          oeq: some-value,some-other-value
        example-2:
          eq: some-value
    ControlPlaneGeoFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeoFieldEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldNotEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldOrEqualityFilter"
      title: ControlPlaneGeoFieldFilter
    CloudGatewaysStringFieldFilterOverride:
      description: "Filter using **one** of the following operators: `eq`, `oeq`,
        `neq`, `contains`, `ocontains`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        contains:
          description: The field contains the provided value.
          type: string
          example: ?filter[field_name_here][contains]=foo
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
        ocontains:
          description: The field contains any of the provided values.
          type: string
          example: ?filter[field_name_here][ocontains]=foo,bar
      additionalProperties: false
      x-examples:
        example-1:
          contains: some-value
          neq: not-this-value
          oeq: some-value,some-other-value
          ocontains: this-value,or-that-value
        example-2:
          eq: some-value
    CustomDomainStateFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/CustomDomainStateFieldEqualsFilter"
        - $ref: "#/components/schemas/CustomDomainStateFieldNotEqualsFilter"
        - $ref: "#/components/schemas/CustomDomainStateFieldOrEqualityFilter"
      title: CustomDomainStateFieldFilter
    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
    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
```
