---
title: "Add-Ons Filter Parameters"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/34323df8-534b-4175-a049-34445622158f/schemas/AddOnsFilterParameters"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/34323df8-534b-4175-a049-34445622158f.md

# Add-Ons Filter Parameters

Filter parameters for add-ons list operation.

## 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:
    CloudGatewaysStringFieldFilterOverride:
      oneOf:
        - $ref: "#/components/schemas/CloudGatewaysStringFieldEqualsFilterOverride"
        - $ref: "#/components/schemas/StringFieldContainsFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
        - $ref: "#/components/schemas/StringFieldOContainsFilter"
      title: CloudGatewaysStringFieldFilterOverride
    AddOnStateFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/AddOnStateFieldEqualsFilter"
        - $ref: "#/components/schemas/AddOnStateFieldNotEqualsFilter"
        - $ref: "#/components/schemas/AddOnStateFieldOrEqualityFilter"
      title: AddOnStateFieldFilter
    AddOnConfigKindFieldFilter:
      description: Filter for add-on config kind field.
      oneOf:
        - $ref: "#/components/schemas/AddOnConfigKindFieldEqualsFilter"
        - $ref: "#/components/schemas/AddOnConfigKindFieldNotEqualsFilter"
        - $ref: "#/components/schemas/AddOnConfigKindFieldOrEqualityFilter"
      title: Add-On Config Kind Field Filter
    UuidFieldFilter:
      description: Filters on the given UUID field value by exact match.
      oneOf:
        - $ref: "#/components/schemas/StringFieldEqualsFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
      title: UuidFieldFilter
      x-examples:
        example-1: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-2:
          eq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-3:
          oeq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-4:
          neq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
    ControlPlaneGeoFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeoFieldEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldNotEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldOrEqualityFilter"
      title: ControlPlaneGeoFieldFilter
    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
    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
    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
    AddOnStateFieldEqualsFilter:
      description: Filter add-on state by exact match.
      oneOf:
        - $ref: "#/components/schemas/AddOnState"
        - $ref: "#/components/schemas/AddOnStateFieldEqualsComparison"
      title: AddOnStateFieldEqualsFilter
      x-examples:
        example-1: ready
        example-2:
          eq: ready
    AddOnStateFieldNotEqualsFilter:
      description: Filter add-on state by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/AddOnState"
      additionalProperties: false
      required:
        - neq
      title: AddOnStateFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: ready
    AddOnStateFieldOrEqualityFilter:
      description: >
        Filter add-on 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
      additionalProperties: false
      required:
        - oeq
      title: AddOnStateFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: ready,initializing
    AddOnConfigKindFieldEqualsFilter:
      description: Filter add-on config kind by exact match.
      oneOf:
        - $ref: "#/components/schemas/AddOnConfigKind"
        - $ref: "#/components/schemas/AddOnConfigKindFieldEqualsComparison"
      title: Add-On Config Kind Field Equals Filter
    AddOnConfigKindFieldNotEqualsFilter:
      description: Filter add-on config kind by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/AddOnConfigKind"
      additionalProperties: false
      required:
        - neq
      title: Add-On Config Kind Field Not Equals Filter
    AddOnConfigKindFieldOrEqualityFilter:
      description: Filter add-on config kind by determining if the value is equal to
        any in a set of values.
      type: object
      properties:
        oeq:
          description: Comma-delimited list of add-on kinds.
          type: string
      additionalProperties: false
      required:
        - oeq
      title: Add-On Config Kind Field Or Equality Filter
    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
    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
    AddOnState:
      description: >
        The current state of the add-on. Possible values:

        - `initializing` - The add-on is in the process of being
        initialized/updated.

        - `ready` - The add-on is fully operational.

        - `terminating` - The add-on is in the process of being deleted.
      type: string
      enum:
        - initializing
        - ready
        - terminating
      readOnly: true
      title: Add-On State
    AddOnStateFieldEqualsComparison:
      type: object
      properties:
        eq:
          $ref: "#/components/schemas/AddOnState"
      additionalProperties: false
      required:
        - eq
      title: AddOnStateFieldEqualsComparison
    AddOnConfigKind:
      description: Type of add-on config.
      type: string
      enum:
        - managed-cache.v0
      title: Add-On Config Kind
    AddOnConfigKindFieldEqualsComparison:
      type: object
      properties:
        eq:
          $ref: "#/components/schemas/AddOnConfigKind"
      additionalProperties: false
      required:
        - eq
      title: AddOnConfigKindFieldEqualsComparison
    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
    AddOnsFilterParameters:
      description: Filter parameters for add-ons list operation.
      type: object
      properties:
        name:
          $ref: "#/components/schemas/CloudGatewaysStringFieldFilterOverride"
        state:
          $ref: "#/components/schemas/AddOnStateFieldFilter"
        config.kind:
          $ref: "#/components/schemas/AddOnConfigKindFieldFilter"
        owner.control_plane_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        owner.control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeoFieldFilter"
        owner.control_plane_group_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        owner.control_plane_group_geo:
          $ref: "#/components/schemas/ControlPlaneGeoFieldFilter"
      additionalProperties: false
      title: Add-Ons Filter Parameters
```
