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

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

# PrivateDnsFilterParameters

## 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:
    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
    PrivateDnsStateFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/PrivateDnsStateFieldEqualsFilter"
        - $ref: "#/components/schemas/PrivateDnsStateFieldNotEqualsFilter"
        - $ref: "#/components/schemas/PrivateDnsStateFieldOrEqualityFilter"
      title: PrivateDnsStateFieldFilter
    PrivateDnsStateFieldEqualsFilter:
      description: Filter Private DNS state by exact match.
      oneOf:
        - $ref: "#/components/schemas/PrivateDnsState"
        - type: object
          title: PrivateDnsStateFieldEqualsComparison
          properties:
            eq:
              $ref: "#/components/schemas/PrivateDnsState"
          required:
            - eq
      title: PrivateDnsStateFieldEqualsFilter
      x-examples:
        example-1: ready
        example-2:
          eq: ready
    PrivateDnsStateFieldNotEqualsFilter:
      description: Filter private-dns state by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/PrivateDnsState"
      required:
        - neq
      title: PrivateDnsStateFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: ready
    PrivateDnsStateFieldOrEqualityFilter:
      description: >
        Filter Private DNS 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: PrivateDnsStateFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: ready,initializing
    PrivateDnsState:
      description: >
        The current state of the Private DNS attachment. Possible values:

        - `created` - The attachment has been created but is not attached to
        Private DNS.

        - `initializing` - The attachment is in the process of being initialized
        and is setting up necessary resources.

        - `pending-association` The attachment request is awaiting association
        to the cloud provider infrastructure in order for provisioning to
        proceed.

        - `ready` - The attachment is fully operational and can route traffic as
        configured.

        - `error` - The attachment is in an error state, and is not operational.

        - `terminating` - The attachment is in the process of being deleted.

        - `terminated` - The attachment has been fully deleted and is no longer
        available.
      type: string
      enum:
        - created
        - initializing
        - pending-association
        - ready
        - error
        - terminating
        - terminated
      title: Private DNS State
    PrivateDnsFilterParameters:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/CloudGatewaysStringFieldFilterOverride"
        state:
          $ref: "#/components/schemas/PrivateDnsStateFieldFilter"
      additionalProperties: false
      title: PrivateDnsFilterParameters
```
