---
title: "VulnerabilityServiceFilterParameters"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/VulnerabilityServiceFilterParameters"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# VulnerabilityServiceFilterParameters

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              type: string
              description: The field exactly matches the provided value.
              example: ?filter[field_name_here][eq]=foo
            contains:
              type: string
              description: The field contains the provided value.
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              type: string
              description: The field contains any of the provided values.
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              type: string
              description: The field matches any of the provided values.
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              type: string
              description: The field does not match the provided value.
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    LabelsFieldFilter:
      allOf:
        - title: LabelsFieldFilter
          description: >
            Filters on the resource's `labels` field. Filters must use
            dot-notation to identify

            the label key that will be used to filter the results. For example:
              - `filter[labels.owner]`
              - `filter[labels.owner][neq]=kong`
              - `filter[labels.env]=dev`
              - `filter[labels.env][ocontains]=dev,test`
        - $ref: "#/components/schemas/StringFieldFilter"
    StringFieldFilterExact:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
      properties:
        eq:
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[field_name_here][eq]=foo
        oeq:
          type: string
          description: The field matches any of the provided values.
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          type: string
          description: The field does not match the provided value.
          example: ?filter[field_name_here][neq]=bar
      type: object
      additionalProperties: false
    DateTimeFieldFilter:
      title: DateTimeFieldFilter
      description: Filters on the given datetime (RFC-3339) field value.
      oneOf:
        - type: string
          title: DateTimeFieldImplicitEqualsFilter
          format: date-time
          description: Value strictly equals given RFC-3339 formatted timestamp in UTC
          example: 2022-03-30T07:20:50Z
        - type: object
          title: DateTimeFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              type: string
              format: date-time
              description: Value strictly equals given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - eq
        - type: object
          title: DateTimeFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              type: string
              format: date-time
              description: Value is less than the given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - lt
        - type: object
          title: DateTimeFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              type: string
              format: date-time
              description: Value is less than or equal to the given RFC-3339 formatted
                timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - lte
        - type: object
          title: DateTimeFieldGTFilter
          additionalProperties: false
          properties:
            lt:
              type: string
              format: date-time
              description: Value is greater than the given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - gt
        - type: object
          title: DateTimeFieldGTEFilter
          additionalProperties: false
          properties:
            lte:
              type: string
              format: date-time
              description: Value is greater than or equal to the given RFC-3339 formatted
                timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - gte
      x-examples:
        datetime_field_1: 2022-03-30T07:20:50Z
        datetime_field_2:
          eq: 2022-03-30T07:20:50Z
        datetime_field_3:
          lt: 2022-03-30T07:20:50Z
        datetime_field_4:
          lte: 2022-03-30T07:20:50Z
        datetime_field_5:
          gt: 2022-03-30T07:20:50Z
        datetime_field_6:
          gte: 2022-03-30T07:20:50Z
    NumericFieldFilter:
      description: Filter by a numeric value.
      oneOf:
        - type: number
          description: Value strictly equals the given numeric value.
          example: 21
        - type: object
          title: NumericFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              type: number
              description: Value strictly equals the given numeric value.
              example: 3.14
          required:
            - eq
        - type: object
          title: NumericFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              type: number
              description: Value is less than the given numeric value.
              example: 10
          required:
            - lt
        - type: object
          title: NumericFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              type: number
              description: Value is less than or equal to the given numeric value.
              example: 10
          required:
            - lte
        - type: object
          title: NumericFieldGTFilter
          additionalProperties: false
          properties:
            gt:
              type: number
              description: Value is greater than the given numeric value.
              example: 1.85
          required:
            - gt
        - type: object
          title: NumericFieldGTEFilter
          additionalProperties: false
          properties:
            gte:
              type: number
              description: Value is greater than or equal to the given numeric value.
              example: 1.85
          required:
            - gte
      x-examples:
        numeric_field_1: 11
        numeric_field_2:
          eq: 11
        numeric_field_3:
          lt: 15.85
        numeric_field_4:
          lte: 15.85
        numeric_field_5:
          gt: 3.14
        numeric_field_6:
          gte: 3.14
    BooleanFieldFilter:
      title: BooleanFieldFilter
      description: Filter by a boolean value (true/false).
      type: boolean
      x-examples:
        example-1: true
    VulnerabilityServiceFilterParameters:
      title: VulnerabilityServiceFilterParameters
      type: object
      allOf:
        - type: object
          properties:
            name:
              $ref: "#/components/schemas/StringFieldFilter"
            display_name:
              $ref: "#/components/schemas/StringFieldFilter"
            labels:
              $ref: "#/components/schemas/LabelsFieldFilter"
            vulnerability.state:
              $ref: "#/components/schemas/StringFieldFilterExact"
            vulnerability.opened_at:
              $ref: "#/components/schemas/DateTimeFieldFilter"
            vulnerability.reopened_at:
              $ref: "#/components/schemas/DateTimeFieldFilter"
            vulnerability.last_opened_at:
              $ref: "#/components/schemas/DateTimeFieldFilter"
            vulnerability.dismissed_at:
              $ref: "#/components/schemas/DateTimeFieldFilter"
            vulnerability.fixed_at:
              $ref: "#/components/schemas/DateTimeFieldFilter"
            vulnerability.instance_count:
              $ref: "#/components/schemas/NumericFieldFilter"
            custom_fields:
              description: >
                Filter by custom fields using dot-notation to specify the custom
                field.

                Filter operators are dictated by the custom field type. For
                example:
                  - `filter[custom_fields.owner]`
                  - `filter[custom_fields.owner][neq]=kong`
                  - `filter[custom_fields.dashboard.link][contains]=https`
              oneOf:
                - $ref: "#/components/schemas/StringFieldFilter"
                - $ref: "#/components/schemas/BooleanFieldFilter"
                - $ref: "#/components/schemas/NumericFieldFilter"
```